swift-zulip-api 0.3.0

swift-zulip-api 0.3.0

Marco Burstein 维护。



A library to access the Zulip API with Swift.

Travis CI build status GitHub tag language badge

使用 Swift 访问 Zulip API 的库。

安装

Swift Package Manager

swift-zulip-api 可以通过 Swift Package Manager 安装。

在您的 dependencies 中,添加 https://github.com/skunkmb/swift-zulip-api.git

dependencies: [
    .package(
        url: "https://github.com/skunkmb/swift-zulip-api.git",
        from: "0.3.0"
    )
]

CocoaPods

swift-zulip-api 也可以通过 CocoaPods 安装。

在您的 Podfile 中添加 swift-zulip-api

pod 'swift-zulip-api'

然后在终端中运行 pod install

pod install

用法

设置

// Set up a Zulip configuration.
let config = Config(
    emailAddress: "[email protected]",
    apiKey: "yourapikey",
    realmURL: "https://example.com"
)

// Create the Zulip client.
let zulip = Zulip(config: config)

功能

`swift-zulip-api` 被分为几个不同的命名空间,每个都有自己的功能

消息

let messages = zulip.messages()

查看完整的 messages 文档。

let streams = zulip.streams()

查看完整的 streams 文档。

用户

let users = zulip.users()

查看完整的 users 文档。

事件

let events = zulip.events()

查看完整的 events 文档。

示例

每个函数文档都有使用示例。如果想要看到每个函数在真实示例程序中的使用,还可以查看完整的 Swift 示例文件。可以通过以下命令运行示例:

swift run SwiftZulipAPIExample

在终端中。

机器人

`swift-zulip-api` 支持编写机器人来自动对用户做出响应。每个机器人在被提及在消息时会做出响应。

查看完整的机器人文档。