Swiftagram Documentation

Extensions on Endpoint.Group.User

Properties

request 

var request: Request

A wrapper for request endpoints.

summary 

var summary: Endpoint.Single<Swiftagram.User.Unit, Error>

A summary for the current user.

followers 

var followers: Endpoint.Paginated<Swiftagram.User.Collection, RankedOffset<String?, String?>, Error>

A list of profiles following the user.

following 

var following: Endpoint.Paginated<Swiftagram.User.Collection, RankedOffset<String?, String?>, Error>

A list of profiles followed by the user.

friendship 

var friendship: Endpoint.Single<Swiftagram.Friendship, Error>

The current friendship status between the given user and the logged in one.

higlights 

var higlights: Endpoint.Single<TrayItem.Collection, Error>

A list of highlights uploaded by the user.

posts 

var posts: Endpoint.Paginated < Swiftagram.Media.Collection,
                                  String?,
                                  Error>

A list of posts uploaded by the user.

similar 

var similar: Endpoint.Single<Swiftagram.User.Collection, Error>

A list of similar/suggested users.

stories 

var stories: Endpoint.Single<TrayItem.Unit, Error>

A list of all recent stories by the user.

tags 

var tags: Endpoint.Paginated < Swiftagram.Media.Collection,
                                 RankedOffset<String?, String?>,
                                 Error>

A list of posts the user was tagged in.

Methods

block() 

func block() -> Endpoint.Single<Friendship.Unit, Error>

Block the given user.

Returns

A valid Endpoint.Single.

follow() 

func follow() -> Endpoint.Single<Friendship.Unit, Error>

Follow the given user.

Returns

A valid Endpoint.Single.

mute(_:​) 

func mute(_ action: Muting) -> Endpoint.Single<Friendship.Unit, Error>

Mute the given user.

Parameters

action Muting

A valid Muting.

Returns

A valid Endpoint.Single.

remove() 

func remove() -> Endpoint.Single<Friendship.Unit, Error>

Remove the given user from your followers.

Returns

A valid Endpoint.Single.

unblock() 

func unblock() -> Endpoint.Single<Friendship.Unit, Error>

Unblock the given user.

Returns

A valid Endpoint.Single.

unfollow() 

func unfollow() -> Endpoint.Single<Friendship.Unit, Error>

Unfollow the given user.

Returns

A valid Endpoint.Single.

unmute(_:​) 

func unmute(_ action: Muting) -> Endpoint.Single<Friendship.Unit, Error>

Unmute the given user.

Parameters

action Muting

A valid Muting.

Returns

A valid Endpoint.Single.

followers(matching:​) 

func followers(matching query: String) -> Endpoint.Paginated<Swiftagram.User.Collection, RankedOffset<String?, String?>, Error>

A list of profiles following the user.

Parameters

query String

A valid String.

Returns

A valid Endpoint.Paginated.

following(matching:​) 

func following(matching query: String) -> Endpoint.Paginated<Swiftagram.User.Collection, RankedOffset<String?, String?>, Error>

A list of profiles followed by the user.

Parameters

query String

A valid String.

Returns

A valid Endpoint.Paginated.