Interface AirshipContact

Airship contact.

Hierarchy

AirshipContact

Index

Methods

editAttributes editSubscriptionLists editTagGroups getNamedUserId getSubscriptionLists identify notifyRemoteLogin registerEmail registerSMS reset

Methods

editAttributes

editAttributes(): AttributeEditor
Edits attributes.

Returns
An attribute editor.

Returns AttributeEditor
- Defined in index.d.ts:2072

editSubscriptionLists

editSubscriptionLists(): ScopedSubscriptionListEditor
Edits subscription lists.

Returns
A subscription list editor.

Returns ScopedSubscriptionListEditor
- Defined in index.d.ts:2078

editTagGroups

editTagGroups(): TagGroupEditor
Edits tag groups.

Returns
A tag group editor.

Returns TagGroupEditor
- Defined in index.d.ts:2066

getNamedUserId

getNamedUserId(success: ((namedUserId: undefined | null | string) => void), error?: ((err: string) => void)): void
Gets the named user Id.
Parameters
- success: ((namedUserId: undefined | null | string) => void)
  
  Success callback.
  - - (namedUserId: undefined | null | string): void
    - Parameters
      
      namedUserId: undefined | null | string
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:2047

getSubscriptionLists

getSubscriptionLists(success: ((subscriptionLists: Record<string, SubscriptionScope[]>) => void), error?: ((err: string) => void)): void
Gets the contacts subscription lists.
Parameters
- success: ((subscriptionLists: Record<string, SubscriptionScope[]>) => void)
  
  Success callback.
  - - (subscriptionLists: Record<string, SubscriptionScope[]>): void
    - Parameters
      
      subscriptionLists: Record<string, SubscriptionScope[]>
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:2057

identify

identify(namedUser: string, success?: (() => void), error?: ((err: string) => void)): void
Identifies the contact with a named user Id.
Parameters
- namedUser: string
  
  The named user Id.
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:2016

notifyRemoteLogin

notifyRemoteLogin(success?: (() => void), error?: ((err: string) => void)): void
Notifies the contact of a remote login.
Parameters
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:2037

registerEmail

registerEmail(email: string, options: EmailRegistrationOptions, success?: (() => void), error?: ((err: string) => void)): void
Registers an email channel for the contact.
Parameters
- email: string
  
  The email address.
- options: EmailRegistrationOptions
  
  Registration options.
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:2087

registerSMS

registerSMS(msisdn: string, options: SmsRegistrationOptions, success?: (() => void), error?: ((err: string) => void)): void
Registers an SMS channel for the contact.
Parameters
- msisdn: string
  
  The MSISDN, including country code.
- options: SmsRegistrationOptions
  
  Registration options.
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:2101

reset

reset(success?: (() => void), error?: ((err: string) => void)): void
Resets the contact.
Parameters
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:2027

Interface AirshipContact

Hierarchy

Index

Methods

Methods

editAttributes

Returns

Returns AttributeEditor

editSubscriptionLists

Returns

Returns ScopedSubscriptionListEditor

editTagGroups

Returns

Returns TagGroupEditor

getNamedUserId

Parameters

success: ((namedUserId: undefined | null | string) => void)

Parameters

namedUserId: undefined | null | string

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

getSubscriptionLists

Parameters

success: ((subscriptionLists: Record<string, SubscriptionScope[]>) => void)

Parameters

subscriptionLists: Record<string, SubscriptionScope[]>

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

identify

Parameters

namedUser: string

Optional success: (() => void)

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

notifyRemoteLogin

Parameters

Optional success: (() => void)

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

registerEmail

Parameters

email: string

options: EmailRegistrationOptions

Optional success: (() => void)

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

registerSMS

Parameters

msisdn: string

options: SmsRegistrationOptions

Optional success: (() => void)

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

reset

Parameters

Optional success: (() => void)

`Optional` error: ((err: string) => void)

`Optional` error: ((err: string) => void)

`Optional` success: (() => void)

`Optional` error: ((err: string) => void)

`Optional` success: (() => void)

`Optional` error: ((err: string) => void)

`Optional` success: (() => void)

`Optional` error: ((err: string) => void)

`Optional` success: (() => void)

`Optional` error: ((err: string) => void)

`Optional` success: (() => void)

`Optional` error: ((err: string) => void)