InAppTools

InAppTools 是一个用 Swift 编写的库，让您可以轻松地将移动用户添加到您的邮件列表中。

要使用 InAppTools，您首先需要生成一个 API 密钥。要生成一个，请登录 https://inapptools.com 并选择“个人资料”。然后，在“API 密钥”下，单击“新建 API 密钥”并按照说明操作。

• Xcode 14 / Swift 5.7
• iOS >= 15.0
• macOS >= 12.0

对于以下所有示例，请提前导入库

import InAppTools

要获取您的邮件列表 ID，请登录 https://inapptools.com 并复制您的邮件列表的 List ID。

一旦用户输入了他们的电子邮件地址，您就可以通过以下方式将他们订阅到邮件列表

let member = try await MailingList(apiKey: apiKey).subscribe(listId: listId, email: email)

如果 subscribe 方法抛出异常，最可能的原因是不正确的 apiKey 或不正确的 listId。 使用已订阅到您的邮件列表的电子邮件调用 subscribe 不会造成错误。

返回的 member 是一个结构体，其中包含保存的属性的副本，以及一个 uuid 属性。 如果您以后想让用户能够取消订阅，请将其保存在某个地方

您可以向订阅调用添加许多可选属性

let member = try await MailingList(apiKey: apiKey).subscribe(listId: listId, email: email, firstName: firstName, lastName: lastName, name: name, fields: fields, tags: tags)

• firstName、lastName、name：一些邮件列表平台对名字/姓氏与全名有不同的处理方式。提示用户输入适合您的邮件列表平台的内容，并省略其余内容。
• fields：一组键值对，可用于以后对用户进行细分。
• tags：一组应与此用户关联的“标签”。

返回的 member 是一个结构体，其中包含保存的属性的副本，以及一个 uuid 属性。 如果您以后想让用户能够取消订阅，请将其保存在某个地方

let member = try await mailingList.unsubscribe(listId: listId, uuid: uuid)

取消订阅用户不会删除服务器上的记录 - 它只是在邮件列表平台上将他们标记为“已取消订阅”。要重新订阅他们，请再次调用 subscribe 函数。

要使用 Swift Package Manager 使用 Xcode 安装 InAppTools

1. 在 Xcode 中，选择“文件”->“添加 Package Dependencies...”
2. 输入 https://github.com/dhennessy/inapptools-ios-sdk.git

或者您可以将以下依赖项添加到您的 Package.swift

.package(url: "https://github.com/dhennessy/inapptools-ios-sdk.git", from: "0.1.0")

将以下行添加到您的 Podfile

pod 'InAppTools'

请参阅 CHANGELOG.md 获取更改列表。

如果您在使用 InAppTools 时遇到任何问题，我们感谢您在 GitHub Issues 上提交错误报告。

InAppTools 在 MIT 许可下可用。 有关更多信息，请参阅 LICENSE.md。