RxGitLabAPIClient

public class RxGitLabAPIClient

This class represents the main entry point to the RxGitLabKit library

This client is used for the communication with GitLabAPI.

currentUserObservable
Observable of the current user
Declaration
Swift

public var currentUserObservable: Observable<User?> { get }
defaultPerPage
Default per page accoring to GitLab Docs
Declaration
Swift

public static let defaultPerPage: Int
apiVersionURLString
String representation of API v4 URI
Declaration
Swift

public static var apiVersionURLString: String { get }
hostURL
GitLab Host URL
Declaration
Swift

public var hostURL: URL { get }


                    
                    
                    privateToken

Private Token

Declaration

Swift

public var privateToken: String? { get set }


                    
                    
                    oAuthToken

OAuthToken

Declaration

Swift

public var oAuthToken: String? { get set }

Endpoint Groups


                    
                    
                    authentication

Endpoint group for Authentication

Declaration

Swift

public lazy var authentication: AuthenticationEndpointGroup { get set }


                    
                    
                    projects

Endpoint group for Projects

Declaration

Swift

public lazy var projects: ProjectsEnpointGroup { get set }


                    
                    
                    repositories

Endpoint group for Repositories

Declaration

Swift

public lazy var repositories: RepositoriesEndpointGroup { get set }


                    
                    
                    commits

Endpoint group for Commits

Declaration

Swift

public lazy var commits: CommitsEndpointGroup { get set }


                    
                    
                    users

Endpoint group for Users

Declaration

Swift

public lazy var users: UsersEndpointGroup { get set }


                    
                    
                    members

Endpoint group for Members

Declaration

Swift

public lazy var members: MembersEndpointGroup { get set }

Init


                    
                    
                    init(with:)

Undocumented

Declaration

Swift

public init(with hostCommunicator: HostCommunicator)


                    
                    
                    init(with:)

Undocumented

Declaration

Swift

public convenience init(with hostURL: URL)


                    
                    
                    init(with:privateToken:using:)

Undocumented

Declaration

Swift

public convenience init(with hostURL: URL, privateToken: String, using network: Networking? = nil)


                    
                    
                    init(with:oAuthToken:using:)

Undocumented

Declaration

Swift

public convenience init(with hostURL: URL, oAuthToken: String, using network: Networking? = nil)

Public Functions


                    
                    
                    changeHostURL(hostURL:)

Changes the GitLab Host URL

Declaration

Swift

public func changeHostURL(hostURL: URL)

Parameters


                                hostURL

The desired host URL


                    
                    
                    logIn(username:password:)

Logs in a user using an username and password

Declaration

Swift

public func logIn(username: String, password: String)

Parameters

`username`	username or e-mail
`password`	password


                    
                    
                    logIn(privateToken:)

Sets the private token for communication with GitLab API server

Declaration

Swift

public func logIn(privateToken: String)

Parameters


                                privateToken

A private token


                    
                    
                    logIn(oAuthToken:)

Sets the OAuth token for communication with GitLab API server

Declaration

Swift

public func logIn(oAuthToken: String)

Parameters


                                privateToken

An OAuth token

logOut()
Logs out the current user
Declaration
Swift

public func logOut()