Repository files navigation

A library to access the Zulip API withSwift.

swift-zulip-api can be installed with theSwift Package Manager.

In yourdependencies, addhttps://github.com/zulip/swift-zulip-api.git:

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

swift-zulip-api can also be installed withCocoaPods.

In yourPodfile, addswift-zulip-api.

pod'swift-zulip-api'

Then runpod install from the terminal.

pod install

import SwiftZulipAPI// Set up a Zulip configuration.letconfig=Config(    emailAddress:"email@example.com",    apiKey:"yourapikey",    realmURL:"https://example.com")// Create the Zulip client.letzulip=Zulip(config: config)

swift-zulip-api is split into a few different namespaces, each with their ownfunctions:

messages:

letmessages= zulip.messages()

See the fullmessages docs.

streams:

letstreams= zulip.streams()

See the fullstreams docs.

users:

letusers= zulip.users()

See the fullusers docs.

events:

letevents= zulip.events()

See the fullevents docs.

Each of the function docs has examples for how to use the functions. There isalso afull Swift example fileif you want to see every function being used in an actual example program.The example can be run by using

swift run SwiftZulipAPIExample

from the terminal.

swift-zulip-api supports writing Bots to automatically respond to users. Eachbot will respond when it is mentioned in a message.

See the full bots docs.