Inherits from NSObject
Conforms to UserVariable
Declared in SFSUserVariable.h
SFSUserVariable.m

Overview

The UserVariable class is used to represent variables maintained on the Server side and automatically updated to the clients.

See User, SetUserVariablesRequest

Tasks

Properties

name

The Variable name

@property (readonly) NSString *name

Discussion

The Variable name

Declared In

SFSUserVariable.h

type

The Variable Type

@property (readonly) NSString *type

Discussion

The Variable Type

Declared In

SFSUserVariable.h

Class Methods

variableWithName:value:type:

the name of the variable

+ (id)variableWithName:(NSString *)name value:(id)value type:(NSInteger)type

Parameters

name

the name of the variable

value

the variable value ( can be Boolean, int, Number, String, SFSObject, SFSArray )

type

(optional -1) it’s usually not necessary to pass this parameter as the variable value is auto-detected

Declared In

SFSUserVariable.h

Instance Methods

getBoolValue

The Variable value as BOOL

- (BOOL)getBoolValue

Discussion

The Variable value as BOOL

Declared In

SFSUserVariable.h

getDoubleValue

The Variable value as Number

- (NSNumber *)getDoubleValue

Discussion

The Variable value as Number

Declared In

SFSUserVariable.h

getIntValue

The Variable value as NSInteger

- (NSInteger)getIntValue

Discussion

The Variable value as NSInteger

Declared In

SFSUserVariable.h

getSFSArrayValue

The Variable value as SFSArray

- (id<ISFSArray>)getSFSArrayValue

Discussion

The Variable value as SFSArray

Declared In

SFSUserVariable.h

getSFSObjectValue

The Variable value as SFSObject

- (id<ISFSObject>)getSFSObjectValue

Discussion

The Variable value as SFSObject

See Also

Declared In

SFSUserVariable.h

getStringValue

The Variable value as NSString

- (NSString *)getStringValue

Discussion

The Variable value as NSString

Declared In

SFSUserVariable.h

getValue

The Variable value

- (id)getValue

Discussion

The Variable value

Declared In

SFSUserVariable.h

isNull

Checks if the variable value is null

- (BOOL)isNull

Discussion

Checks if the variable value is null

Declared In

SFSUserVariable.h