swift-zulip-api Swift logo Swift logo

Travis CI build status GitHub tag language badge

一个使用 Swift 访问 Zulip API 的库。

安装

Swift Package Manager

可以使用 Swift Package Manager 安装 swift-zulip-api

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

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

CocoaPods

也可以使用 CocoaPods 安装 swift-zulip-api

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

pod 'swift-zulip-api'

然后从终端运行 pod install

pod install

用法

设置

import SwiftZulipAPI

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

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

函数

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

messages

let messages = zulip.messages()

查看完整的 messages 文档。

streams

let streams = zulip.streams()

查看完整的 streams 文档。

users

let users = zulip.users()

查看完整的 users 文档。

events

let events = zulip.events()

查看完整的 events 文档。

示例

每个函数文档都有关于如何使用这些函数的示例。如果您想查看每个函数如何在实际示例程序中使用,还有一个完整的 Swift 示例文件。该示例可以通过使用

swift run SwiftZulipAPIExample

从终端运行。

机器人

swift-zulip-api 支持编写机器人来自动回复用户。每个机器人将在消息中被提及时回复。

查看完整的机器人文档。