NativeScript Zendesk Chat UI

为 iOS 和 Android 提供Zendesk Chat SDK。

安装

描述您的插件安装步骤。理想情况下，它可能类似于

tns plugin add nativescript-zendesk-chat-ui

用法

ZendeskChatUi.initialize(key); // your key here
ZendeskChatUi.startChat(); // start a chat

API

ZendeskChatUi

方法	默认值	描述
startChat(chatConfig?: ChatConfig)	null	使用聊天配置启动聊天。
initialize(accountKey: string)	null	您的 Zendesk 聊天账户密钥。必需。
trackEvent(eventDescription: string)	null	跟踪事件。

属性	默认值	描述
visitorInfo: VisitorInfo	null	设置用户的电子邮件、姓名、电话号码、备注。
chatOverlayEnabled: boolean	true	隐藏聊天叠加层。仅限 iOS

VisitorInfo

export interface VisitorInfo {
  name?: string;
  email?: string;
  phoneNumber?: string;
  note?: string;
}

ChatConfig

export interface ChatConfig {
  department?: string;
  tags?: string[];
  uploadAttachmentsEnabled?: boolean; // ios only
  preChatDataRequirements?: { // required fields the user will have to fill
    department: PreChatDataRequirement;
    email: PreChatDataRequirement;
    message: PreChatDataRequirement;
    name: PreChatDataRequirement;
    phone: PreChatDataRequirement;
  };
}

PreChatDataRequirement

export enum PreChatDataRequirement {
  NotRequired = 0,
  Optional = 1,
  Required = 2,
  OptionalEditable = 3,
  RequiredEditable = 4
}

定制

有关定制信息，请参阅 iOS 和 Android 文档。

许可证

Apache 许可证版本 2.0，2004 年 1 月