RVP_Cocoa_SDK_User

public class RVP_Cocoa_SDK_User : A_RVP_Cocoa_SDK_Data_Object

Public Stored Properties

Public Properties and Calculated Properties

  • Declaration

    Swift

    override public var asDictionary: [String : Any?] { get }

    Return Value

    all of the values for this object, as a Dictionary. READ ONLY

  • Declaration

    Swift

    public var surname: String? { get set }

    Return Value

    the user surname, as an optional String

  • Declaration

    Swift

    public var middleName: String? { get set }

    Return Value

    the user middle name, as an optional String

  • Declaration

    Swift

    public var givenName: String? { get set }

    Return Value

    the user given (first) name, as an optional String

  • Declaration

    Swift

    public var nickname: String? { get set }

    Return Value

    the user nickname, as an optional String

  • Declaration

    Swift

    public var prefix: String? { get set }

    Return Value

    the user prefix, as an optional String

  • Declaration

    Swift

    public var suffix: String? { get set }

    Return Value

    the user suffix, as an optional String

  • NOTE: Although this will let anyone with write permission set the ID, it will not be accepted on the server, unless the admin also has at least read permissions for the login object.

    Declaration

    Swift

    public var loginID: String { get set }

    Return Value

    the associated login ID (if any). “”, if no associated login.

  • NOTE: Although this will let anyone with write permission set the ID, it will not be accepted on the server, unless the admin also has at least read permissions for the login object.

    Declaration

    Swift

    public var associatedLoginID: Int { get set }

    Return Value

    the associated login ID (if any). 0, if no associated login.

  • Declaration

    Swift

    public var tag7: String { get set }

    Return Value

    the tag7 String.

  • Declaration

    Swift

    public var tag8: String { get set }

    Return Value

    the tag8 String.

  • Declaration

    Swift

    public var tag9: String { get set }

    Return Value

    the tag9 String.

Public Instance Methods

  • This is the default initializer.

    Declaration

    Swift

    public override init(sdkInstance inSDKInstance: RVP_Cocoa_SDK?, objectInfoData inData: [String : Any])

    Parameters

    sdkInstance

    REQUIRED (Can be nil) This is the SDK instance that “owns” this object. It may be nil for history instances.
    objectInfoData

    REQUIRED This is the parsed JSON data for this object, as a Dictionary.

  • This method tells the SDK to fetch the associated login object.

    Nothing happens, if this user does not have an associated login.

    Declaration

    Swift

    public func fetchLoginInstance(refCon inRefCon: Any?) -> Bool

    Parameters

    refCon

    This is an optional Any parameter that is simply returned after the call is complete. “refCon” is a very old concept, that stands for “Reference Context.” It allows the caller of an async operation to attach context to a call.

    Return Value

    true, if we have an instance, and have requested it be fetched. False, if we have no instance.

Base Class Override

  • This deletes the object from the server (if the current login has permission). This will delete associated login instances.

    Declaration

    Swift

    public override func delete(refCon inRefCon: Any?)

    Parameters

    refCon

    This is an optional Any parameter that is simply returned after the call is complete. “refCon” is a very old concept, that stands for “Reference Context.” It allows the caller of an async operation to attach context to a call.