Options
All
  • Public
  • Public/Protected
  • All
Menu

React Native Zendesk (@idopterlabs/rn-zendesk) - v0.5.0

Index

Type aliases

CallbackRequestNewToken: () => void

Type declaration

    • (): void
    • Returns void

Functions

  • Initialize the SDK

    example
    RNZendesk.init({
    key: 'ip1MZws0A17aDjg8wjfs2sfQ8AeUJFe5',
    appId: 'd89309417eb165b6b5041234371c16a5bsjfc2f49a027b4c',
    clientId: 'mobile_sdk_client_9326b42367cca4c2d2f',
    url: 'https://MY_ZENDESK.zendesk.com',
    isEnabledLoggable: false,
    });

    Parameters

    • initializationOptions: InitOptions

      Startup and Access Settings

    Returns void

  • setNotificationToken(token: string): void
  • Register notifications token with zendesk

    example
    RNZendesk.setNotificationToken('123456');
    

    Parameters

    • token: string

      Token string

    Returns void

  • setPrimaryColor(color: string): void
  • Set primary color code for the chat theme

    example
    RNZendesk.setPrimaryColor('#3762ff');
    

    Parameters

    • color: string

      HEX Color String

    Returns void

  • Set user identity for authentication when you want to use chat or ticket sdk

    example
    RNZendesk.setUserIdentity({
    token: '1234567890abcdef',
    isEnabledJwtAuthenticator: true
    }, async () => {
    RNZendesk.updateUserToken('1234567890abcdef');
    });

    Parameters

    Returns void

  • setVisitorInfo(visitorInfo: UserInfo): void
  • Set visitor info in chat

    example
    RNZendesk.setVisitorInfo({});
    

    Parameters

    Returns void

  • Open the help center

    example
    RNZendesk.showHelpCenter({});
    

    Parameters

    Returns void

  • showTicketList(): void
  • Open the page with all user tickets

    example
    RNZendesk.showTicketList();
    

    Returns void

  • Open the chat

    example
    RNZendesk.startChat({});
    

    Parameters

    Returns void

  • Display chat if you have online agent or ticket form

    example
    RNZendesk.startChatOrTicket({});
    

    Parameters

    Returns void

  • startTicket(): void
  • Open the ticket form

    example
    RNZendesk.startTicket();
    

    Returns void

  • updateUserToken(newToken: string): void
  • Set a new token for the chat

    example
    RNZendesk.updateUserToken('1234567890abcdef');
    

    Parameters

    • newToken: string

      Token string

    Returns void