使用方法

要运行示例项目，请克隆存储库，然后先从Example目录中运行pod install。

需求

安装

appygram_ios可以通过CocoaPods获取。要安装它，只需将以下行添加到您的Podfile中：

pod "appygram_ios"

入门

将appygram_ios引入项目依赖项后，发送Appygrams的关键组件是创建一个AppygramMessenger实例。该对象将允许您发送Appygram消息以及检索主题列表。

AppygramMessenger绑定到某个API密钥，因此您将需要通过AppygramConfig对您的信使进行配置。您可以有两种方法实现：

使用全局AppygramMessenger

如果您的应用程序在整个应用程序中仅使用一个API密钥，您可以通过调用Appygram.configure快速配置一个静态的、全局的信使实例。配置调用需要一个AppygramConfig对象，如下所述。从那里，您可以通过调用Appygram.Global()简单地从您的代码中的任何位置访问AppygramMessenger对象。

创建特定的AppygramMessage实例。

如果您的应用程序可能有多个API密钥，或者您希望不使用静态对象，您可以通过调用Appygram.instance创建一个特定的AppygramMessenger实例。此调用需要一个AppygramConfig对象，如下所述，并返回一个AppygramMessenger。请使用此对象在您的应用程序中发送消息。

无论您选择哪种方法来设置您的AppygramMessenger，您都需要传递AppygramConfig，它允许您设置以下属性

• key（必需）- 您的Appygram API密钥。
• topic - 所有Appygrams的默认主题（默认为null）
• url - Appygram端点的URL（默认为当前值）
• platform - 关于您平台的其他信息
• software - 关于您软件的其他信息

AppygramConfig 构造函数也可以接受一个 Dictionary 对象。下面列出了支持的性质，它们依次对应于上面提到的性质：

• com.appygram.java.key (必需)
• com.appygram.java.topic
• com.appygram.java.url
• com.appygram.java.platform
• com.appygram.java.software

创建此对象，设置适当的信息。然后，要配置一个全局 AppygramMessenger

Appygram.configure(AppygramConfig(api_key: "my-API-key"))

或者，要创建一个 AppygramMessenger 的实例

AppygramMessenger messenger = Appygram.instance(AppygramConfig(api_key: "my-API-key"))

现在您已经准备好创建 Appygrams。为了简便，下面的示例将假定您正在使用全局 AppygramMessenger，但使用特定实例时，这些方法也适用。

发送 Appygram 消息

要创建一个 AppygramMessage 对象，您只需调用

var message : AppygramMessage = Appygram.Global().create()

这将生成一条新消息，其中包含您之前配置中指定的任何默认值。从那时起，您可以设置以下字段

• 主题 - 在消息路由中非常重要
• 主题
• 消息
• 姓名
• 电子邮件
• 电话
• 平台
• 软件
• app_json - 分配到此字段的任何对象都将序列化为 JSON。您可以提供一个 Dictionary，该 Dictionary 允许您通过键来引用对象。默认为 null。

AppygramMessage 对象可以扩展，以便您可以在开发中提供自己的自定义实现。

设置消息后，只需调用

Appygram.Global().send(message)

这将发送 Appygram 信息到您指定的端点，完成即可。

监听 Appygrams

如果您想在代码中收到 Appygram 已发送的通知，可以创建一个を実装クラスAppygramEventHandler。此协议具有一个名为 afterSend 的单个函数，它接受包含已发送消息、成功布尔值和（如果可用）响应消息的 AppygramEvent。要设置，请调用

Appygram.Global().addAfterSendHandler(handler);

Appygram 主题

要获取您在 Appygram.com 上设置的所有主题信息列表，可以调用

Appygram.Global().topics() { (topics : Array<AppygramTopic>) in
  println(topics)
} 

这将列出您所有的主题，您可以使用 AppygramTopic 上的 id 和 name 变量将其呈现给您的客户。

作者

Carl Scott, [email protected]

许可证

appygram_ios 处于 MIT 许可证下。有关更多信息，请参阅 LICENSE 文件。