Server

public class Server : ModelObject

Representation of an Usher Server.

Server Details
  • serverURL

    URL of the server

    Declaration

    Swift

    @objc
public private(set) dynamic var serverURL: String
  • serverName

    Name of the server

    Declaration

    Swift

    @objc
public private(set) dynamic var serverName: String
  • serverVersion

    Version of the server

    Declaration

    Swift

    @objc
public private(set) dynamic var serverVersion: String
  • supportEmail

    Customer support email address

    Declaration

    Swift

    @objc
public private(set) dynamic var supportEmail: String
  • supportEmailLabel

    Customer support email label (For UI display purposes)

    Declaration

    Swift

    @objc
public private(set) dynamic var supportEmailLabel: String
  • supportPhone

    Customer support phone number

    Declaration

    Swift

    @objc
public private(set) dynamic var supportPhone: String
  • supportPhoneLabel

    Customer support phone label (For UI display purposes)

    Declaration

    Swift

    @objc
public private(set) dynamic var supportPhoneLabel: String
  • feedBackEmail

    Customer feedback email address

    Declaration

    Swift

    @objc
public private(set) dynamic var feedBackEmail: String
  • feedbackEmailLabel

    Customer feedback email label (For UI display purposes)

    Declaration

    Swift

    @objc
public private(set) dynamic var feedbackEmailLabel: String

Externally computed & set values
  • badgeCount

    Number of badges installed from the server on the current device.

    Declaration

    Swift

    @objc
public internal(set) dynamic var badgeCount: Int
  • isDefault

    Boolean that indicates if the server is the default one on the current device.

    Declaration

    Swift

    @objc
public internal(set) dynamic var isDefault: Bool

Convinience Initialization
  • init(name:url:accessToken:refreshToken:)

    Initializes a server object

    Declaration

    Swift

    @objc
public convenience init(name: String, url: String, accessToken: String? = nil, refreshToken: String? = nil)
    Parameters
    name

    The server name
    url

    The server URL string (including port number if any)
    accessToken

    Server access token.
    refreshToken

    Server refresh token.
  • serverVersionAtLeast(version:)

    Compares if the server version is the same or higher than the provided server version

    Declaration

    Swift

    public func serverVersionAtLeast(version: String) -> Bool
    Parameters
    version

    Server version string
    Return Value

    true if the current server version is same or higher than the provided server version.

  • dataForWatch()

    Miniature dictionary representation of a server object for a watch app.

    Declaration

    Swift

    public func dataForWatch() -> [String : Any]
    Return Value

    Dictionary with values for accessToken, serverURL, serverName and type

  • save()

    Store the server informatin into cache

    Declaration

    Swift

    public func save()