Latest 0.1.2
Homepage https://github.com/skunkmb/zulip-swift
License MIT
Platforms ios 8.0, osx 10.10, tvos 9.0, watchos 2.0
Dependencies Alamofire
Authors

swift-zulip-api Swift logo Swift logo

Travis CI build status
GitHub tag
language badge

A library to access the Zulip API with Swift.

Installation

Swift Package Manager

swift-zulip-api can be installed with the
Swift Package Manager.

In your dependencies, add
https://github.com/skunkmb/swift-zulip-api.git:

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

CocoaPods

swift-zulip-api can also be installed with CocoaPods.

In your Podfile, add swift-zulip-api.

pod 'swift-zulip-api'

Then run pod install from the terminal.

pod install

Usage

Set-up

// 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)

Functions

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

messages:

let messages = zulip.messages()

See the full messages docs.

streams:

let streams = zulip.streams()

See the full streams docs.

users:

let users = zulip.users()

See the full users docs.

events:

let events = zulip.events()

See the full events docs.

Latest podspec

{
    "name": "zulip-swift",
    "version": "0.1.2",
    "summary": "A library to access the Zulip API with Swift.",
    "license": {
        "type": "MIT"
    },
    "authors": {
        "Marco Burstein": "[email protected]"
    },
    "homepage": "https://github.com/skunkmb/zulip-swift",
    "source_files": "sources/ZulipSwift",
    "source": {
        "git": "https://github.com/skunkmb/zulip-swift.git",
        "tag": "0.1.2"
    },
    "platforms": {
        "ios": "8.0",
        "osx": "10.10",
        "tvos": "9.0",
        "watchos": "2.0"
    },
    "dependencies": {
        "Alamofire": [
            "~> 4.7"
        ]
    }
}

Pin It on Pinterest

Share This