Entity

public class Entity : CustomStringConvertible, CustomDebugStringConvertible, ExtendedEquatable

Immutable Model for an Organisational unit

  • id

    Entity ID

    Declaration

    Swift

    public internal(set) var id: String
  • Entity name

    Declaration

    Swift

    public internal(set) var name: String
  • url

    Entity URL Name

    The full url of an entity, for example the-entity.biid.com, consists of a url name (the-entity) and a url domain (biid.com)

    Declaration

    Swift

    public internal(set) var url: String
  • Entity icon URL

    Declaration

    Swift

    public internal(set) var iconURL: String?
  • Indicates whether this Entity is the currently selected Entity.

    Important

    Important

    This is only set correctly in entities returned from a requestEntitiesForUser() call. Otherwise will always show False

    Declaration

    Swift

    public internal(set) var selected: Bool
  • Entity terms & conditions Document

    Declaration

    Swift

    public internal(set) var terms: Document?
  • Entity privacy Document

    Declaration

    Swift

    public internal(set) var privacy: Document?
  • Description of entity

    Declaration

    Swift

    public internal(set) var entityDescription: String?
  • User status for this entity.

    Declaration

    Swift

    public internal(set) var userStatus: User.Status?
  • Init

    Declaration

    Swift

    public init(id: String, name: String, url: String, iconURL: String?, selected: Bool, terms: Document?, privacy: Document?, description: String?, userStatus: User.Status?)
  • Initialize Entity with ID.

    Convenience constructor to create an Entity with an ID. The created entity can be used as the parameter to the selectEntity() API

    Declaration

    Swift

    public convenience init(withID id: String)

    Parameters

    id

    the Entity’s ID

  • Returns a URL to the Privacy document for the entity

    Declaration

    Swift

    public func getPrivacyURL() -> String?
  • Returns a URL to the Terms & Conditions document for the entity

    Declaration

    Swift

    public func getTermsURL() -> String?
  • CustomStringConvertible

    Declaration

    Swift

    public var description: String { get }
  • CustomDebugStringConvertible

    Declaration

    Swift

    public var debugDescription: String { get }