Class Android

    • Field Detail

      • JSON_PROPERTY_TYPE

        public static final java.lang.String JSON_PROPERTY_TYPE
        See Also:
        Constant Field Values
      • type

        protected java.lang.String type
      • JSON_PROPERTY_PROJECT_ID

        public static final java.lang.String JSON_PROPERTY_PROJECT_ID
        See Also:
        Constant Field Values
      • JSON_PROPERTY_CLIENT_EMAIL

        public static final java.lang.String JSON_PROPERTY_CLIENT_EMAIL
        See Also:
        Constant Field Values
      • JSON_PROPERTY_PRIVATE_KEY

        public static final java.lang.String JSON_PROPERTY_PRIVATE_KEY
        See Also:
        Constant Field Values
      • JSON_PROPERTY_SERVER_KEY

        public static final java.lang.String JSON_PROPERTY_SERVER_KEY
        See Also:
        Constant Field Values
      • JSON_PROPERTY_SENDER_ID

        public static final java.lang.String JSON_PROPERTY_SENDER_ID
        See Also:
        Constant Field Values
      • JSON_PROPERTY_CAN_USER_CREATE_MORE_CONVERSATIONS

        public static final java.lang.String JSON_PROPERTY_CAN_USER_CREATE_MORE_CONVERSATIONS
        See Also:
        Constant Field Values
      • JSON_PROPERTY_ATTACHMENTS_ENABLED

        public static final java.lang.String JSON_PROPERTY_ATTACHMENTS_ENABLED
        See Also:
        Constant Field Values
      • JSON_PROPERTY_DEFAULT_RESPONDER_ID

        public static final java.lang.String JSON_PROPERTY_DEFAULT_RESPONDER_ID
        See Also:
        Constant Field Values
      • JSON_PROPERTY_DEFAULT_RESPONDER

        public static final java.lang.String JSON_PROPERTY_DEFAULT_RESPONDER
        See Also:
        Constant Field Values
    • Constructor Detail

      • Android

        public Android()
    • Method Detail

      • getType

        @Nullable
        public java.lang.String getType()
        <aside class=\"notice\">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](https://console.firebase.google.com/). 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.
        Overrides:
        getType in class Integration
        Returns:
        type
      • setType

        public void setType​(java.lang.String type)
        Overrides:
        setType in class Integration
      • projectId

        public Android projectId​(java.lang.String projectId)
      • getProjectId

        @Nullable
        public java.lang.String getProjectId()
        Your project ID from your generated private key file.
        Returns:
        projectId
      • getProjectId_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getProjectId_JsonNullable()
      • setProjectId_JsonNullable

        public void setProjectId_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> projectId)
      • setProjectId

        public void setProjectId​(java.lang.String projectId)
      • clientEmail

        public Android clientEmail​(java.lang.String clientEmail)
      • getClientEmail

        @Nullable
        public java.lang.String getClientEmail()
        Your client email from your generated private key file.
        Returns:
        clientEmail
      • getClientEmail_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getClientEmail_JsonNullable()
      • setClientEmail_JsonNullable

        public void setClientEmail_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> clientEmail)
      • setClientEmail

        public void setClientEmail​(java.lang.String clientEmail)
      • privateKey

        public Android privateKey​(java.lang.String privateKey)
      • getPrivateKey

        @Nullable
        public java.lang.String getPrivateKey()
        Your private key from your generated private key file.
        Returns:
        privateKey
      • getPrivateKey_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getPrivateKey_JsonNullable()
      • setPrivateKey_JsonNullable

        public void setPrivateKey_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> privateKey)
      • setPrivateKey

        public void setPrivateKey​(java.lang.String privateKey)
      • serverKey

        public Android serverKey​(java.lang.String serverKey)
      • getServerKey

        @Nullable
        public java.lang.String getServerKey()
        Your server key from the fcm console.
        Returns:
        serverKey
      • getServerKey_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getServerKey_JsonNullable()
      • setServerKey_JsonNullable

        public void setServerKey_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> serverKey)
      • setServerKey

        public void setServerKey​(java.lang.String serverKey)
      • senderId

        public Android senderId​(java.lang.String senderId)
      • getSenderId

        @Nullable
        public java.lang.String getSenderId()
        Your sender id from the fcm console.
        Returns:
        senderId
      • getSenderId_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getSenderId_JsonNullable()
      • setSenderId_JsonNullable

        public void setSenderId_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> senderId)
      • setSenderId

        public void setSenderId​(java.lang.String senderId)
      • canUserCreateMoreConversations

        public Android canUserCreateMoreConversations​(java.lang.Boolean canUserCreateMoreConversations)
      • getCanUserCreateMoreConversations

        @Nullable
        public java.lang.Boolean getCanUserCreateMoreConversations()
        Allows users to create more than one conversation on the android integration.
        Returns:
        canUserCreateMoreConversations
      • setCanUserCreateMoreConversations

        public void setCanUserCreateMoreConversations​(java.lang.Boolean canUserCreateMoreConversations)
      • getAttachmentsEnabled

        @Nullable
        public java.lang.Boolean getAttachmentsEnabled()
        Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center.
        Returns:
        attachmentsEnabled
      • defaultResponderId

        public Android defaultResponderId​(java.lang.String defaultResponderId)
      • getDefaultResponderId

        @Nullable
        public java.lang.String getDefaultResponderId()
        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 <a href=\"https://docs.smooch.io/guide/switchboard/#per-channel-default-responder\">Per-channel default responder</a> guide.
        Returns:
        defaultResponderId
      • getDefaultResponderId_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getDefaultResponderId_JsonNullable()
      • setDefaultResponderId_JsonNullable

        public void setDefaultResponderId_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> defaultResponderId)
      • setDefaultResponderId

        public void setDefaultResponderId​(java.lang.String defaultResponderId)
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class Integration