Rate this page:

PushCredentials

Methods

Adds push credentials

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.
application_id:
number
Optional
The application id.
application_name:
string
Optional
The application name that can be used instead of application_id.
credential_bundle:
string
Optional
The bundle of Android/iOS application.
cert_content:
string
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
The secret password for private key.
is_dev_mode:
boolean
Set true for use this certificate in apple's sandbox environment
sender_id:
string
The sender id, provided by Google.
server_key:
string
The server key, provided by Google.
service_account_file:
string
The service account key file, provided by Google.

Returns

result:
number
push_credential_id:
number

Modifies push credentials

SetPushCredential example

Modify credentials.

Parameters

push_credential_id:
number
The push credentials id.
cert_content:
string
Public and private keys in PKCS12 format.
cert_password:
string
The secret password for private key.
is_dev_mode:
boolean
Set true for use this certificate in apple's sandbox environment
sender_id:
string
The sender id, provided by Google.
server_key:
string
The server key, provided by Google.

Returns

result:
number

Removes push credentials

DelPushCredential example

Remove credentials.

Parameters

push_credential_id:
number
The push credentials id.

Returns

result:
number

Gets push credentials

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 the bound application.
application_id:
number
Optional
The id of the bound application.
with_cert:
boolean
Optional
Set true to get the user's certificate.

Returns

result:
[PushCredentialInfo]

Binds push credentials to applications

BindPushCredential example

Bind the push credential to the application.

Parameters

push_credential_id:
intlist
The push credentials ID list separated by the ';' symbol.
application_id:
intlist
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