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
-
nameThe Variable name
property -
typeThe Variable Type
property -
+ variableWithName:value:type:the name of the variable
-
– getValueThe Variable value
-
– getBoolValueThe Variable value as BOOL
-
– getIntValueThe Variable value as NSInteger
-
– getDoubleValueThe Variable value as Number
-
– getStringValueThe Variable value as NSString
-
– getSFSObjectValueThe Variable value as SFSObject
-
– getSFSArrayValueThe Variable value as SFSArray
-
– isNullChecks if the variable value is null
Properties
name
The Variable name
@property (readonly) NSString *nameDiscussion
The Variable name
Declared In
SFSUserVariable.hClass Methods
variableWithName:value:type:
the name of the variable
+ (id)variableWithName:(NSString *)name value:(id)value type:(NSInteger)typeParameters
- 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.hInstance Methods
getBoolValue
The Variable value as BOOL
- (BOOL)getBoolValueDiscussion
The Variable value as BOOL
Declared In
SFSUserVariable.hgetDoubleValue
The Variable value as Number
- (NSNumber *)getDoubleValueDiscussion
The Variable value as Number
Declared In
SFSUserVariable.hgetIntValue
The Variable value as NSInteger
- (NSInteger)getIntValueDiscussion
The Variable value as NSInteger
Declared In
SFSUserVariable.hgetSFSArrayValue
The Variable value as SFSArray
- (id<ISFSArray>)getSFSArrayValueDiscussion
The Variable value as SFSArray
Declared In
SFSUserVariable.hgetSFSObjectValue
The Variable value as SFSObject
- (id<ISFSObject>)getSFSObjectValueDiscussion
The Variable value as SFSObject
See Also
Declared In
SFSUserVariable.hgetStringValue
The Variable value as NSString
- (NSString *)getStringValueDiscussion
The Variable value as NSString
Declared In
SFSUserVariable.h