Class SeamHttpSeamMobileSdkV1PhoneSessions

constructor

• new SeamHttpSeamMobileSdkV1PhoneSessions(apiKeyOrOptions?): SeamHttpSeamMobileSdkV1PhoneSessions

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

getOrCreate

• getOrCreate(parameters?, options?): SeamMobileSdkV1PhoneSessionsGetOrCreateRequest

• Parameters

  • Optionalparameters: {
        custom_sdk_installation_id: string;
        phone_device_metadata?: {
            manufacturer?: string;
            model?: string;
            os_version?: string;
        };
        phone_os: "android" | "ios";
    }

    • custom_sdk_installation_id: string

      ID of the custom SDK installation that you want to use for the new session.

    • Optionalphone_device_metadata?: {
          manufacturer?: string;
          model?: string;
          os_version?: string;
      }

      Phone device metadata that you want to use for the new session.

      • Optionalmanufacturer?: string

      • Optionalmodel?: string

      • Optionalos_version?: string

    • phone_os: "android" | "ios"

      Phone operating system that you want to use for the new session.
  • options: SeamMobileSdkV1PhoneSessionsGetOrCreateOptions = {}

  Returns SeamMobileSdkV1PhoneSessionsGetOrCreateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpSeamMobileSdkV1PhoneSessions

• Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

StaticfromClient

• fromClient(client, options?): SeamHttpSeamMobileSdkV1PhoneSessions

• Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSeamMobileSdkV1PhoneSessions

• Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpSeamMobileSdkV1PhoneSessions

• Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpSeamMobileSdkV1PhoneSessions

• Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpSeamMobileSdkV1PhoneSessions

StaticfromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpSeamMobileSdkV1PhoneSessions>

• Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpSeamMobileSdkV1PhoneSessions>