ContactsService データ型

ContactsService は複数のデータ型を定義して使用します。

取引先責任者を表すオブジェクト。

プロパティ名説明
idString各取引先責任者に固有の文字列化された数字。取引先責任者作成時にネイティブデバイスによって生成されます。42
nameContactName取引先責任者の名前を表すオブジェクト。{familyName: "Locklear", givenName: "Awanasa"}
phoneNumbersContactLabeledValue取引先責任者の電話番号が含まれるオブジェクトの配列。[{mobile: "2065550100"}, {work: "3435550101"}, { home: "6195550102"}]
emailsContactLabeledValue取引先責任者のメールアドレスが含まれるオブジェクトの配列。[{personal: "awanasa_locklear_736251@hotmail.com"}, {work: "awanasa_locklear_fake_work_email@employer.com"}]
addressesContactAddress取引先責任者の住所を表すオブジェクト。{type: "work", streetAddress: "415 Mission St", locality: "San Francisco", postalCode: "94105"}
imsContactLabeledValue取引先責任者のインスタントメッセージング (IM) ユーザー名が含まれるオブジェクトの配列。[{hangouts: "a_locklear"}, {telegram: "awanasa.data"}]
orgaizationsContactOrganization取引先責任者の組織を表すオブジェクト。{name: "Main Stage Analytics", department: "Data Engineering", title: "Data Scientist"}
noteString取引先責任者に関する追加情報のためのテキスト項目。Mother-in-law's neighbor
urlsContactLabeledValue取引先責任者の URL が含まれるオブジェクトの配列。[{company_website_1: "www.salesforce.com"}, {company_website_2: "www.tableau.com"}, {company_website_3: "https://slack.com"}]

取引先責任者の名前を表すオブジェクト。

プロパティ名説明
displayNameString取引先責任者について表示される名前を表す文字列。Android デバイスでのみ表示されます。Chan Ming Lewis
familyNameString取引先責任者の家名 (「名字」や「姓」とも呼ばれる) を表す文字列。Lewis
givenNameString取引先責任者の名前 (「名」とも呼ばれる) を表す文字列。Chan
middleNameString取引先責任者のミドルネームを表す文字列。Ming
namePrefixString取引先責任者の名前プレフィックスを表す文字列。Mr.
nameSuffixString取引先責任者の名前サフィックスを表す文字列。Jr.

取引先責任者の住所を表すオブジェクト。

プロパティ名説明
typeString取引先責任者の住所の種別を表す文字列。Work
streetAddressString取引先責任者の住所の町名・番地を表す文字列。415 Mission St
localityString取引先責任者の住所の地域 (「市区町村」とも呼ばれる) を表す文字列。San Francisco
regionString取引先責任者の住所の地方 (「州」または「都道府県」とも呼ばれる) を表す文字列。California
postalCodeString取引先責任者の住所の郵便番号を表す文字列。94105
countryString取引先責任者の住所の国を表す文字列。U.S.A.

取引先責任者の組織を表すオブジェクト。

プロパティ名説明
nameString取引先責任者の組織の名前を表す文字列。Salesforce
departmentString取引先責任者の組織の部署を表す文字列。Engineering
titleString取引先責任者が組織で持っている役職を表す文字列。Senior Program Manager

その他の取引先責任者情報の表示ラベルと値が含まれるオブジェクト。

| プロパティ名| 型| 説明| 例| |----------|----------|----------|----------|----------| | label| String| value のデータを分類する表示名。次の例では、homehomepageworklabel プロパティです。|

  • {home: "6195550102"}
  • {homepage: "https://developer.salesforce.com"}
  • {work: "alex_driskell@example.com"}
| | value| String| label で指定されたデータの値。|
  • {home: "6195550102"}
  • {homepage: "https://developer.salesforce.com"}
  • {work: "alex_driskell@example.com"}
| |

表示ラベルと値はプラットフォームによって提供され、ContactsService によって変更されません。Android と iOS の連絡先アプリケーションでは電話番号やメールアドレスに「自宅」や「職場」などの項目の標準の表示ラベルが用意されていますが、カスタム表示ラベル値を入力することもできます。特定の表示ラベルテキスト、または電話番号などの特定の形式の値に依存している表示ラベル付きの値を処理するときは注意してください。

ContactsService セッションの設定の詳細を表すオブジェクト。

プロパティ名説明
permissionRationaleTextStringAndroid のみの省略可能なパラメーター。これは、ユーザーの最初の拒否の後にのみ表示されます。デフォルトの権限メッセージを使用するには、空のオブジェクトで渡します。デフォルトの権限メッセージは「To import Contacts, permission is needed to access Contacts. Tap Allow in the following permissions dialog. (取引先責任者をインポートするには、取引先責任者にアクセスする権限が必要です。次の権限ダイアログで [許可] をタップしてください。)」です。アプリケーションで取引先責任者に関連する機能を使用するには取引先責任者へのアクセス権が必要です。

ContactsService の機能にアクセスしたときに発生するエラーを表すオブジェクト。

プロパティ名説明
codeContactsServiceFailureCode取引先責任者のエラーが発生した理由を表す値。次のような失敗コードを使用できます。
  • USER_DISMISSED
  • USER_DENIED_PERMISSION
  • USER_DISABLED_PERMISSION
  • USER_RESTRICTED_PERMISSION
  • SERVICE_NOT_ENABLED
  • UNKNOWN_REASON
messageString失敗した理由を説明する文字列値。この値は、ユーザーインターフェースメッセージでの使用に適しています。メッセージは英語で提供されます。ローカライズはされません。