Share via

ApnsCredential interface

  • Reference
Package:
@azure/arm-notificationhubs

Description of a NotificationHub ApnsCredential.

Properties

apnsCertificate

The APNS certificate. Specify if using Certificate Authentication Mode.
appId

The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode.
appName

The name of the application or BundleId. Specify if using Token Authentication Mode.
certificateKey

The APNS certificate password if it exists.
endpoint

The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'.
keyId

A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode.
thumbprint

The APNS certificate thumbprint. Specify if using Certificate Authentication Mode.
token

Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode.

Property Details

apnsCertificate

The APNS certificate. Specify if using Certificate Authentication Mode.

apnsCertificate?: string

Property Value

string

appId

The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode.

appId?: string

Property Value

string

appName

The name of the application or BundleId. Specify if using Token Authentication Mode.

appName?: string

Property Value

string

certificateKey

The APNS certificate password if it exists.

certificateKey?: string

Property Value

string

endpoint

The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'.

endpoint?: string

Property Value

string

keyId

A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode.

keyId?: string

Property Value

string

thumbprint

The APNS certificate thumbprint. Specify if using Certificate Authentication Mode.

thumbprint?: string

Property Value

string

token

Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode.

token?: string

Property Value

string