Rate this page:

PushCredentials

Methods

AddPushCredential

Copy URL

Add push credentials

AddPushCredential example

AddPushCredential example

Add new Apple credentials.

Parameters

  • push_provider_name:

    string

    The push provider name. The possible values are: APPLE, APPLE_VOIP, GOOGLE.

  • push_provider_id:

    number

    The push provider id.

  • credential_bundle:

    string

    Optional

    The bundle of Android/iOS application.

  • cert_content:

    string

    Optional

    Public and private keys in PKCS12 format.

  • cert_file_name:

    string

    Optional

    The parameter is required, when set 'cert_content' as POST body.

  • cert_password:

    string

    Optional

    The secret password for private key.

  • is_dev_mode:

    boolean

    Optional

    Set true for use this certificate in apple's sandbox environment

  • sender_id:

    string

    Optional

    The sender id, provided by Google.

  • server_key:

    string

    Optional

    The server key, provided by Google.

Returns

  • result:

    number

  • push_credential_id:

    number

SetPushCredential

Copy URL

Modify push credentials

SetPushCredential example

SetPushCredential example

Modify credentials.

Parameters

  • push_credential_id:

    number

    Optional

    The push credentials id.

  • cert_content:

    string

    Optional

    Public and private keys in PKCS12 format.

  • cert_password:

    string

    Optional

    The secret password for private key.

  • is_dev_mode:

    boolean

    Optional

    Set true for use this certificate in apple's sandbox environment

  • sender_id:

    string

    Optional

    The sender id, provided by Google.

  • server_key:

    string

    Optional

    The server key, provided by Google.

Returns

  • result:

    number

DelPushCredential

Copy URL

Remove push credentials

DelPushCredential example

DelPushCredential example

Remove credentials.

Parameters

  • push_credential_id:

    number

    Optional

    The push credentials id.

Returns

  • result:

    number

GetPushCredential

Copy URL

Get push credentials

GetPushCredential example

GetPushCredential example

Get push credentials.

Parameters

  • push_credential_id:

    number

    Optional

    The push credentials id.

  • push_provider_name:

    string

    Optional

    The push provider name. The possible values are: APPLE, APPLE_VOIP, GOOGLE.

  • push_provider_id:

    number

    Optional

    The push provider id.

  • application_name:

    string

    Optional

    The name of bound application.

  • application_id:

    number

    Optional

    The id of bound application.

  • with_cert:

    boolean

    Optional

    Set true to get the user's certificate.

Returns

BindPushCredential

Copy URL

Bind push credentials to applications

BindPushCredential example

BindPushCredential example

Bind the push credential to the application.

Parameters

  • push_credential_id:

    intlist

    Optional

    The push credentials ID list separated by the ';' symbol.

  • application_id:

    intlist

    Optional

    The application ID list separated by the ';' symbol or the 'all' value.

  • bind:

    boolean

    Optional

    Set to false for unbind. Default value is true.

Returns

  • result:

    number