diff --git a/apidoc/Titanium/Contacts/Contacts.yml b/apidoc/Titanium/Contacts/Contacts.yml index 3663a592bfe..5631dfea1b0 100644 --- a/apidoc/Titanium/Contacts/Contacts.yml +++ b/apidoc/Titanium/Contacts/Contacts.yml @@ -247,6 +247,21 @@ methods: type: Callback properties: + - name: includeNote + summary: A boolean value that indicates whether to fetch the notes stored in contacts or not. + description: | + This property need to be set before calling contacts APIs. + From iOS 13 or later if your app fetch note field from contact, the app must have to set key 'com.apple.developer.contacts.notes' to 'true' in entitelements section of tiapp.xml. + + com.apple.developer.contacts.notes + + + See more details at https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_contacts_notes and https://developer.apple.com/contact/request/contact-note-field. + type: Boolean + default: true + platforms: [iphone, ipad] + since: 8.2.1 + - name: CONTACTS_KIND_ORGANIZATION summary: Specifies that a contact is an organization. description: | @@ -565,4 +580,4 @@ properties: --- name: ContactsAuthorizationResponse summary: Argument passed to the callback when a request finishes successfully or erroneously. -extends: ErrorResponse \ No newline at end of file +extends: ErrorResponse