Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IProfileDataEditor

Batch's Profile Data Editor. See https://doc.batch.com/ios/custom-data/custom-attributes for more info.

Hierarchy

  • IProfileDataEditor

Index

Methods

Methods

addToArray

  • addToArray(key: string, value: string[]): any

removeAttribute

  • removeAttribute(key: string): any

removeFromArray

  • removeFromArray(key: string, value: string[]): any

setAttribute

setEmailAddress

  • setEmailAddress(email: undefined | null | string): any

  • Associate an email address to this profile.

    This requires to have a custom user ID registered with the identify API.

    Parameters

    • email: undefined | null | string

      must be valid, not longer than 256 characters. It must match the following pattern: ^[^@]+@[A-z0-9-.]+.[A-z0-9]+$. Null to erase.

    Returns any

setEmailMarketingSubscription

  • setEmailMarketingSubscription(state: "subscribed" | "unsubscribed"): any

  • The profile's marketing emails subscription.

    Note that profile's subscription status is automatically set to unsubscribed when they click an unsubscribe link.

    Parameters

    • state: "subscribed" | "unsubscribed"

      You can set it to subscribed or unsubscribed.

    Returns any

setLanguage

  • setLanguage(language: undefined | null | string): any

  • Associate a language to this profile.

    Parameters

    • language: undefined | null | string

      must be 2 chars, lowercase, ISO 639 formatted

    Returns any

setRegion

  • setRegion(region: undefined | null | string): any

  • Associate a region to this profile.

    Parameters

    • region: undefined | null | string

      must be 2 chars, uppercase, ISO 3166 formatted

    Returns any

Generated using TypeDoc