- Special cases
- Required permissions
AppointmentList (Function) In french: RendezVousListe
 Not available
Lists the appointments found on the mobile device (Android/iOS) and corresponding to the specified criteria.
// Lists all the appointments for the day
StartDate is Date = DateSys()
EndDate is Date = DateSys()
EndDate.Day += 1
arrAPT is array of Appointment = AppointmentList(Null, StartDate, EndDate)
//--------------------------------------------------------------
// Lists all the future appointments from next week
StartDate is Date = DateSys()
StartDate.Day += 7
arrAPT is array of Appointment = AppointmentList(Null, StartDate)
//--------------------------------------------------------------
// Lists the future appointments found in <MyCalendar>
// that contain "car" in the title or in the description of the appointment
arrAPT is array of Appointment = AppointmentList(MyCalendar, "", "", ...
aptTitle + aptContent, "car")
//--------------------------------------------------------------
// Finds an appointment corresponding to a given identifier
arrAPT is array of Appointment = AppointmentList(Null, "", "", aptIdentifier, nID)
Syntax
<Result> = AppointmentList([<Calendar> [, <Start> [, <End> [, <Filter> [, <Sought value>]]]]])
<Result>: Array of Appointment variables Array of Appointment variables initialized with the list of appointments corresponding to the specified criteria. If an error occurred, the array is empty and the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo. <Calendar>: Optional Calendar variable - Name of the Calendar variable that describes the calendar (organizer) containing the appointments to list.
- NULL to list the appointments found in all available calendars.
Caution: A calendar must exist if it is specified.
<Start>: Optional DateTime Local start date and time for the appointments to list. - If <Start> and <End> are not specified, only the future appointments will be listed (from today's date and time).
- If only <Start> is specified, all the appointments found after this date will be retrieved (the limit date is set to 01/01/2031).
- If <Start> must not be specified and if at least one of the following parameters must be specified, use an empty string ("").
Remark: If only the date is specified (without specifying the hours, minutes and seconds), the events will be taken into account from the specified date at 0 hour 0 minute 0 second. <End>: Optional DateTime Local end date and time for the appointments to list. - If <Start> and <End> are not specified, only the future appointments will be listed (from today's date and time).
- If only <End> is specified, all the appointments found before this date will be listed (the limit date defined by Google is 01/01/1970).
- If <End> must not be specified and if at least one of the following parameters must be specified, use an empty string ("").
Remark: If only the date is specified (without specifying the hours, minutes and seconds), the events will be taken into account until the specified date at 0 hour 0 minute 0 second (therefore, the events for the day will not be taken into account). <Filter>: Optional Integer constant (or combination of constants) Properties on which the list of appointments must be filtered: | | | aptContent | Filters on the appointment description (contains search). | | aptIdentifier | Filters on the appointment identifiers (exact-match search). | | aptLocation | Filters on the appointment location (contains search). | | aptTitle | Filters on the appointment title (contains search). |
Remark: If several filters are specified (combination of constants), an appointment will be listed if at least one of the filtered properties corresponds to the sought value. <Sought value>: Optional character string Value sought in the filtered properties of the appointment. This search is not case sensitive. Remarks Special cases - The appointment search is always performed taking into account the current time zone. However, the StartDate and EndDate properties of type Appointment are always in the time zone associated with the appointment.
 AppointmentList can be used in the emulator but not in the simulator.
Component: wd270android.aar |
|
|
|