Skip to content

Make list_events example parts fit together. #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Achimh3011 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Make list_events example parts fit together. #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,15 +180,15 @@ Listing events

To list events between two dates, simply do::

events = my_calendar.list_events(
event_list = my_calendar.list_events(
start=timezone("US/Eastern").localize(datetime(2014, 10, 1, 11, 0, 0)),
end=timezone("US/Eastern").localize(datetime(2014, 10, 29, 11, 0, 0)),
details=True
)

This will return a list of Event objects that are between start and end. If no results are found, it will return an empty list (it intentionally will not throw an Exception.)::

for event in calendar_list.events:
for event in event_list.events:
print "{start} {stop} - {subject}".format(
start=event.start,
stop=event.end,
Expand All @@ -197,8 +197,8 @@ This will return a list of Event objects that are between start and end. If no r

The third argument, 'details', is optional. By default (if details is not specified, or details=False), it will return most of the fields within an event. The full details for the Organizer or Attendees field are not populated by default by Exchange. If these fields are required in your usage, then pass details=True with the request to make a second lookup for these values. The further details can also be loaded after the fact using the load_all_details() function, as below::

events = my_calendar.list_events(start, end)
events.load_all_details()
event_list = my_calendar.list_events(start, end)
event_list.load_all_details()

Cancelling an event
```````````````````
Expand Down