App integration

Take advantage of APIs that integrate platform applications and functionality into your own app, such as email, calendar, and BBM. You can also use these APIs to invoke actions from other apps.



Members

Account

Handle account records that are associated with specific users.

  • Account -

    An Account.

  • AccountsChanged -

    The AccountsChanged class provides the necessary information to the client regarding changes that have taken place on Account objects stored on the device.

  • AccountService -

    The AccountService class is the entry point for Account Management.

  • Property -

    The Property class provides the possible values that can be used to describe individual data elements found within Account and Provider objects.

  • Provider -

    A Provider.

  • Result -

    This class is used to return the outcome of an operation requested from AccountService.

  • Service -

    The Service class provides the possible values that can be used as a parameter to an assortment of functions in the AccountService, Account, and Provider classes.

BBM

Integrate the BBM Social Platform into your own applications.

  • ApplicationPermissions -

    Represents a class that provides access to your app's permission settings on the BBM Social Platform.

  • Contact -

    Represents a contact on the BBM Social Platform.

  • ContactService -

    Provides services related to a user's BBM contacts.

  • Context -

    Represents a class that has the necessary context for access to the BBM Social Platform.

  • ImageType -

    Represents the type of the image.

  • MessageService -

    Represents a class that provides a message service for the BBM Social Platform.

  • Permission -

    The type of application permission.

  • PermissionValue -

    The possible values of application permissions.

  • ProfileBox -

    Represents a class that provides access to your app's profile box in the user's BBM profile.

  • ProfileBoxItem -

    Represents an item in your app's profile box inside the user's BBM profile.

  • RegistrationState -

    Represents the RegistrationState of an application on the BBM Social Platform.

  • UserProfile -

    Represents the user's BBM profile.

  • UserStatus -

    Represents the status of a BBM user or contact.

Calendar

Use the features of the Calendar application in your own app.

  • AnalyticsParams -

    The AnalyticsParams class provides parameters for analytics queries.

  • AnalyticsStats -

    The AnalyticsStats class provides statistics for analytics results.

  • Attendee -

    The Attendee class represents a participant of a meeting.

  • AttendeeInEvents -

    The AttendeeInEvents class represents a participant of an event.

  • AttendeeRole -

    The AttendeeRole class includes possible roles for attendees.

  • AttendeeSearchParameters -

    The AttendeeSearchParameters class represents parameters for attendee search.

  • AttendeeStatus -

    The AttendeeStatus class includes possible statuses for attendees.

  • BbmConference -

    The BbmConference class provides data for BBM conference calls.

  • BbmConferencePreferredData -

    The BbmConferencePreferredData class includes data for a BBM conference call.

  • BbmConferenceUserData -

    The BbmConferenceUserData class includes user data for a BBM conference call.

  • BusyStatus -

    The BusyStatus class includes possible free/busy statuses for an event.

  • CalendarEvent -

    The CalendarEvent class represents an event or meeting in a user's calendar.

  • CalendarEventPicker -

    A picker for selecting a calendar event.

  • CalendarEventPickerError -

    An error class for indicating failures when launching the calendar picker.

  • CalendarFolder -

    The CalendarFolder class represents a distinct calendar in the Calendar application.

  • CalendarService -

    The CalendarService class provides access to PIM calendar data.

  • CalendarSettings -

    The CalendarSettings class contains system settings for calendars.

  • CommonAttendee -

    The CommonAttendee class represents an attendee that is common between the user and a specified person.

  • CommonLocation -

    The CommonLocation class represents a meeting location that is common between the user and a specified person.

  • DayOfWeek -

    The DayOfWeek class includes possible days of the week for calendar events.

  • DetailLevel -

    The DetailLevel class includes the possible levels of detail for calendar views.

  • EventKey -

    The EventKey class represents a database key for calendar events.

  • EventRefresh -

    The EventRefresh class represents a notification for added, changed, or deleted events.

  • EventSearchParameters -

    The EventSearchParameters class includes parameters for calendar event searches.

  • FolderKey -

    The FolderKey class represents a database key for calendar folders.

  • Frequency -

    The Frequency class includes possible recurrence frequencies for calendar events.

  • ICalendarConstants -

    A class containing the various iCal constants being used.

  • ICalendarData -

    The ICalendarData class represents iCalendar file data for a calendar event.

  • ICalendarDataPath -

    The ICalendarDataPath class contains information on exported iCalendar files.

  • ICalendarObjects -

    The ICalendarObjects class represents a container for iCalendar objects.

  • ICalendarTodo -

    A to-do object contained in an iCalendar file.

  • ICalendarTodoPriority -

    ICalendarTodoPriority enum class.

  • ICalendarTodoStatus -

    ICalendarTodoStatus enum class.

  • MeetingHistory -

    The MeetingHistory class represents the history of an iCalendar event.

  • Notification -

    The Notification class represents an email notification that's sent to the participants of a meeting.

  • OnlineConferenceData -

    The OnlineConferenceData class includes data for an online conference call.

  • Recurrence -

    The Recurrence class represents recurrence data for calendar events.

  • Result -

    The Result class includes possible result codes for calendar operations.

  • Sensitivity -

    The Sensitivity class includes possible sensitivity levels for calendar events.

  • SortField -

    The SortField class includes possible fields that can be used to sort calendar events.

  • WeekStartDay -

    The WeekStartDay class includes possible recurrence week start days for calendar events.

Contacts

Use the features of the Contacts application in your own app.

  • Activity -

    The Activity class represents the PIM activity types that can be queried.

  • AttributeKind -

    The AttributeKind class contains the possible attribute kinds for a contact.

  • AttributeSubKind -

    The AttributeSubKind class contains the possible attribute sub-kinds for a contact.

  • Contact -

    The Contact class represents contact data, such as name, email address, and postal address.

  • ContactActivity -

    The ContactActivity class represents an interaction with a Contact object.

  • ContactAttribute -

    The ContactAttribute class represents a property of a Contact.

  • ContactAttributeBuilder -

    The ContactAttributeBuilder class lets you create, and specify properties for, a new ContactAttribute or edit an existing ContactAttribute.

  • ContactAutoCompleteSearchFilters -

    The ContactAutoCompleteSearchFilters class represents a set of search filters that are used for auto-complete searches.

  • ContactBuilder -

    The ContactBuilder class lets you create, and specify properties for, a new Contact or edit an existing Contact.

  • ContactFolder -

    The ContactFolder class represents a folder to store contacts.

  • ContactGroup -

    The ContactGroup class represents a group contact which can contain a number of individual contacts as members.

  • ContactGroupBuilder -

    The ContactGroupBuilder class lets you create and specify properties for a new ContactGroup or edit an existing ContactGroup.

  • ContactListFilters -

    The ContactListFilters class represents a set of filters that are used for listing and sorting contacts.

  • ContactMultiSearchFilters -

    The ContactMultiSearchFilters class represents a set of filters that are used to perform multiple searches for specific contacts at once.

  • ContactNews -

    The ContactNews class represents online news for a contact.

  • ContactOnlineStatus -

    The ContactOnlineStatus class represents the online status of a contact.

  • ContactPhoto -

    The ContactPhoto class represents a photo that's associated with a Contact.

  • ContactPhotoBuilder -

    The ContactPhotoBuilder class lets you create, and specify properties for, a new ContactPhoto or edit an existing ContactPhoto.

  • ContactPicker -

    A picker for selecting a contact, multiple contacts, or an attribute of a contact.

  • ContactPostalAddress -

    The ContactPostalAddress class represents a postal address for a contact.

  • ContactPostalAddressBuilder -

    The ContactPostalAddressBuilder class lets you create, and specify properties for, a new ContactPostalAddress or edit an existing ContactPostalAddress.

  • ContactRemoteSearchFilters -

    The ContactRemoteSearchFilters class represents a set of filters that are used for remote searches.

  • ContactSearchFilters -

    The ContactSearchFilters class represents a set of filters that are used to search for specific contacts.

  • ContactSelectionMode -

    Defines the selection mode that a ContactPicker should be launched in.

  • ContactService -

    The ContactService class provides CRUD (create/read/update/delete) operations on Contact objects.

  • ContactType -

    The ContactType class represents the type of contact.

  • NameOrder -

    The NameOrder class represents the orders that can be used for the contacts display name.

  • PerimeterStatus -

    The PerimeterStatus class represents the enterprise perimeter state.

  • SearchAutoCompleteField -

    The SearchAutoCompleteField class represents the fields that a ContactAutoCompleteSearchFilters can apply to.

  • SearchField -

    The SearchField class represents the fields that a ContactSearchFilters can apply to.

  • SelectedContactAttribute -

    Represents the selection of an attribute of a contact from the ContactPicker.

  • SortColumn -

    The SortColumn class represents the columns that can be used to sort contacts.

  • SortOrder -

    The SortOrder class represents the sort order (ascending or descending) of a contact list or search response.

  • VCardPhotoEncoding -

    The VCardPhotoEncoding class represents possible vCard photo encoding types.

Invocation framework

Invoke other applications on the device from within your app by using the invocation framework.

Message

Send messages directly from your app, and save, update, and remove messages from different accounts on the device.

  • Attachment -

    The Attachment class represents an attachment to a message.

  • AttachmentDownloadStatus -

    The AttachmentDownloadStatus class includes possible transmission statuses for attachments in messages.

  • AttachmentEncoding -

    The AttachmentEncoding class represents the encoding type of a message attachment.

  • AttachmentFilter -

    The AttachmentFilter class lets you filter lists of attachments based on key-value pairs.

  • Conversation -

    The Conversation class represents a conversation between message recipients.

  • ConversationBuilder -

    The ConversationBuilder class lets you create, and specify properties for, a new Conversation.

  • ConversationStatus -

    The ConversationStatus class includes possible statuses for conversations.

  • ConversationUpdate -

    The ConversationUpdate class represents updated information for a conversation.

  • FileAttachment -

    The FileAttachment class represents a file attachment.

  • Filter -

    The Filter class represents a filter in the Messages API.

  • Folder -

    The Folder class represents a folder in the Messages API.

  • FollowupFlag -

    The FollowupFlag class represents a follow-up flag in the Messages API.

  • MarkOrDeletePriorFilter -

    The MarkOrDeletePriorFilter class lets you specify options and parameters for prior options.

  • MarkOrDeletePriorOp -

    The MarkOrDeletePriorOp class includes Prior to Date operations for messages.

  • Message -

    The Message class represents information about a message, such as subject, sender and recipient contacts, and status.

  • MessageBody -

    The MessageBody class represents the body of a message.

  • MessageBuilder -

    The MessageBuilder class lets you create, and specify properties for, a new Message or edit an existing Message.

  • MessageClass -

    The MessageClass class includes possible class types for a message.

  • MessageContact -

    The MessageContact class represents a recipient or sender of a message.

  • MessageFilter -

    The MessageFilter class lets you filter lists of messages based on key-value pairs.

  • MessageFlag -

    The MessageFlag class represents the follow-up flag for a message.

  • MessageFolder -

    The MessageFolder class represents a folder to store messages.

  • MessagePriority -

    The MessagePriority class includes priority levels for messages.

  • MessageReplyState -

    The MessageReplyState class includes reply state levels for messages.

  • MessageRights -

    The MessageRights class represents the rights and permissions for a message.

  • MessageSearchFilter -

    The MessageSearchFilter class lets you specify search criteria for messages.

  • MessageService -

    The MessageService class provides access (read, write, and update) to PIM message data.

  • MessageServiceFeature -

    The MessageServiceFeature class includes message service features for an account.

  • MessageStatus -

    The MessageStatus class represents the status of a message.

  • MessageTransaction -

    The MessageTransaction class represents an action that can take place on a particular message in the message database.

  • MessageTransmissionStatus -

    The MessageTransmissionStatus class includes statuses for message transmission.

  • MessageUpdate -

    The MessageUpdate class represents a change or update to a message.

  • MessageUpdateFilter -

    The MessageUpdateFilter class lets you specify options and parameters for bulk options.

  • MimeTypes -

    The MimeTypes class includes constants that represent possible MIME types for messages.

  • OutOfOfficeSettings -

    The OutOfOfficeSettings class includes information about out-of-office replies for messages.

  • SearchFilterCriteria -

    The SearchFilterCriteria class includes possible search criteria that you can use to search for messages.

  • SearchStatusCriteria -

    The SearchStatusCriteria class includes possible statuses that you can use to search for messages.

  • SmsTransport -

    The SmsTransport class lets you perform operations on SMS messages from your apps.

  • SmsTransportRegistrationResult -

    The SmsTransportRegistrationResult class defines possible statuses for port registration requests for an SmsTransport.

  • SmsTransportSendResult -

    The SmsTransportSendResult class defines possible statuses for send requests for an SmsTransport.

  • StatusReport -

    The StatusReport class represents status information for a Message.

  • StatusReportType -

    The StatusReportType class includes possible status types for a message status report.

Notebook

Use these APIs to integrate Notebook application features in your app.

  • Notebook -

    The Notebook class represents a folder-like object that contains notebook entries.

  • NotebookConstraint -

    The NotebookConstraint class represents a constraint on the contents of a Notebook.

  • NotebookDomain -

    The NotebookDomain class provides the available Notebook Domains that a Notebook can contain.

  • NotebookEntry -

    The NotebookEntry class represents an entry that is contained within a Notebook.

  • NotebookEntryAttachment -

    The NotebookEntryAttachment class represents an attachment to a NotebookEntry.

  • NotebookEntryConstraint -

    The NotebookEntryConstraint class represents a constraint on the contents of a NotebookEntry, imposed by the parent Notebook that the NotebookEntry belongs to.

  • NotebookEntryDescription -

    A NotebookEntryDescription is the text content of a NotebookEntry along with its respective type.

  • NotebookEntryDetailLevel -

    The NotebookEntryDetailLevel class represents the detail level of a notebook entry list or search response.

  • NotebookEntryDueDate -

    The NotebookEntryDueDate class provides a set of options for filtering notebook entries by due date or reminder date.

  • NotebookEntryFilter -

    The NotebookEntryFilter class represents a filter that can be used to search and count notebook entries.

  • NotebookEntryHeader -

    The NotebookEntryHeader class represents a header to be shown in a list of NotebookEntry objects.

  • NotebookEntryId -

    The NotebookEntryId class represents the unique ID of a NotebookEntry.

  • NotebookEntrySearchField -

    The NotebookEntrySearchField class provides a set of flags that determine which NotebookEntry fields to search when specified with a NotebookEntryFilter.

  • NotebookEntrySortColumn -

    The NotebookEntrySortColumn class represents the columns that can be used to sort notebook entries.

  • NotebookEntrySortOrder -

    The NotebookEntrySortOrder class represents the sort order (ascending or descending) of a notebook entry list or search response.

  • NotebookEntryStatus -

    The NotebookEntryStatus class provides the available statuses that can be set on a NotebookEntry.

  • NotebookFilter -

    The NotebookFilter class represents a filter that can be used to search and count notebook entries.

  • NotebookId -

    The NotebookId class represents the unique ID of a Notebook.

  • NotebookService -

    The NotebookService class provides CRUD (create/read/update/delete) operations on Notebook objects and their NotebookEntry objects.

  • NotebookServiceResult -

    The NotebookServiceResult class provides status codes that are returned from add, update, and delete functions in NotebookService.

Phone

Retrieve information about past calls.

  • CallAttribute -

    An enumeration of CallEntry attributes for filtering purposes.

  • CallEntry -

    A CallEntry represents the history of a single call.

  • CallEntryResult -

    This class represents the results of fetching CallEntry from CallHistoryService.

  • CallHistoryError -

    Operation result values.

  • CallHistoryFilter -

    CallHistoryFilter provides a way to parameterize which calls are fetched.

  • CallHistoryParam -

    Supplemental parameters for querying call history.

  • CallHistoryService -

    CallHistoryService provides a way to inspect into the history of recently made calls.

  • CallType -

    Call Type constants.

  • ContactEntry -

    This class is used by CallHistoryService to return contact information about a CallHistory.

  • SortOrder -

    Sort order values.

Last modified: 2015-07-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus