SFSUserVariable Class Reference
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.
Tasks
-
name
The Variable name
property -
type
The Variable Type
property -
+ variableWithName:value:type:
the name of the variable
-
– getValue
The Variable value
-
– getBoolValue
The Variable value as BOOL
-
– getIntValue
The Variable value as NSInteger
-
– getDoubleValue
The Variable value as Number
-
– getStringValue
The Variable value as NSString
-
– getSFSObjectValue
The Variable value as SFSObject
-
– getSFSArrayValue
The Variable value as SFSArray
-
– isNull
Checks if the variable value is null
Properties
name
The Variable name
@property (readonly) NSString *name
Discussion
The Variable name
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