Skip to content

Android.md

Latest commit

 

History

History
38 lines (32 loc) · 2.99 KB

Android.md

File metadata and controls

38 lines (32 loc) · 2.99 KB

SunshineConversationsClient::Android

Properties

Name Type Description Notes
default_responder_id String The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href=&quot;https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\&quot;&gt;Switchboard guide</a>. [optional]
default_responder DefaultResponderDefaultResponder [optional]
type String <aside class=&quot;notice&quot;><strong>Note:</strong> Firebase Cloud Messaging has deprecated its legacy APIs for HTTP and XMPP. Legacy credentials <code>serverKey</code> and <code>senderId</code> will stop working as of June 2024 and must be replaced with OAuth 2.0 access token based credentials.</aside> To configure an android integration, first visit the Firebase Console. Generate a private key from the Service accounts tab in the settings. Copy the `project_id`, `client_email` and `private_key` from the generated JSON file and call the create integrations endpoint with this data. [optional][default to 'android']
project_id String Your project ID from your generated private key file. [optional]
client_email String Your client email from your generated private key file. [optional]
private_key String Your private key from your generated private key file. [optional]
server_key String Your server key from the fcm console. [optional]
sender_id String Your sender id from the fcm console. [optional]
can_user_see_conversation_list Boolean Allows users to view their list of conversations. By default, the list of conversations will be visible. This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`. [optional]
can_user_create_more_conversations Boolean Allows users to create more than one conversation on the android integration. [optional]
attachments_enabled Boolean Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center. [optional][readonly]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::Android.new(
  default_responder_id: null,
  default_responder: null,
  type: null,
  project_id: &lt;project-id&gt;,
  client_email: &lt;client-email&gt;,
  private_key: &lt;private-key&gt;,
  server_key: &lt;server-key&gt;,
  sender_id: &lt;sender-id&gt;,
  can_user_see_conversation_list: false,
  can_user_create_more_conversations: null,
  attachments_enabled: null
)