Swiftpack.co - Package - GetStream/stream-swift

Stream Swift Client

Build Status Language: Swift 4.2 Documentation CocoaPods compatible Carthage compatible Swift Package Manager compatible

stream-swift is a Swift client for Stream.

You can sign up for a Stream account at https://getstream.io/get_started.

API Docs

API Examples

Installation

CocoaPods

For Stream, use the following entry in your Podfile:

pod 'GetStream', '~> 1.0'

Then run pod install.

In any file you'd like to use Stream in, don't forget to import the framework with import GetStream.

Swift Package Manager

To integrate using Apple's Swift package manager, add the following as a dependency to your Package.swift:

.package(url: "https://github.com/GetStream/stream-swift.git", .upToNextMajor(from: "1.0.0"))

Carthage

Make the following entry in your Cartfile:

github "GetStream/stream-swift"

Then run carthage update.

Quick start

// Setup a shared Stream client.
Client.config = .init(apiKey: "<#ApiKey#>", appId: "<#AppId#>", token: "<#Token#>")

// Setup a Stream current user with the userId from the Token.
Client.shared.createCurrentUser() { _ in 
    // Do all your requests from here. Reload feeds and etc.
}

// Create a user feed.
let userFeed = Client.shared.flatFeed(feedSlug: "user")

// Create an Activity. You can make own Activity class or struct with custom properties.
let activity = Activity(actor: User.current!, verb: "add", object: "picture:10", foreignId: "picture:10")

userFeed?.add(activity) { result in
    // A result of the adding of the activity.
    print(result)
}

// Create a following relationship between "timeline" feed and "user" feed:
let timelineFeed = Client.shared.flatFeed(feedSlug: "timeline")

timelineFeed?.follow(toTarget: userFeed!.feedId, activityCopyLimit: 1) { result in
    print(result)
}

// Read timeline and user's post appears in the feed:
timelineFeed?.get(pagination: .limit(10)) { result in
    let response = try! result.get()
    print(response.results)
}

// Remove an activity by referencing it's foreignId
userFeed?.remove(foreignId: "picture:10") { result in
    print(result)
}

More API examples here

Credits & Contributors

Project is maintained by Alexey Bukhtin.

We continue to welcome pull requests from community members.

Copyright and License Information

Copyright (c) 2016-2018 Stream.io Inc, and individual contributors. All rights reserved.

See the file "LICENSE" for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.

Github

link
Stars: 8
Help us keep the lights on

Used By

Total: 0

Releases

1.1.9 - Apr 16, 2019

  • The Activity actor now is a User by default.
  • Added createCurrentUser method to simplify the client setup. See docs: https://github.com/GetStream/stream-swift/wiki/Quick-start

1.1.8 - Apr 16, 2019

Fixed dependencies.

1.1.7 - Apr 16, 2019

Fixed dependencies.

1.1.6 - Mar 15, 2019

  • Added the current user property to the UserProtocol.
  • Extracted the original property from Reactionable to OriginalRepresentable protocol.
  • Removed unused property target from ActivityProtocol.

1.1.5 - Mar 5, 2019

  • Added a Bundle extension for Stream setup.
  • Extended Reactionable with original object.
  • Extended Reactionable with user own reactions convenient functions.
  • Added to FeedId a new constructor for the current user .init?(feedSlug: String).
  • Added originFeedId for the Activity.
  • Added associated types for ReactionProtocol.