Click or drag to resize

ISFSObject Interface

The ISFSObject interface defines all the public methods and properties of the SFSObject class used by SmartFoxServer in client-server data transfer.

Namespace:  Sfs2X.Entities.Data
Assembly:  SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
Syntax
C#
public interface ISFSObject

The ISFSObject type exposes the following members.

Methods
  NameDescription
Public methodContainsKey
Indicates whether this object contains a mapping for the specified key or not.
Public methodGetBool
Returns the element corresponding to the specified key as a boolean.
Public methodGetBoolArray
Returns the element corresponding to the specified key as an array of booleans.
Public methodGetByte
Returns the element corresponding to the specified key as a signed byte (8 bits).
Public methodGetByteArray
Returns the element corresponding to the specified key as a ByteArray object.
Public methodCode exampleGetClass
Returns the element corresponding to the specified key as an instance of a custom class.
Public methodGetDouble
Returns the element corresponding to the specified key as a double precision number.
Public methodGetDoubleArray
Returns the element corresponding to the specified key as an array of doubles.
Public methodGetDump
Public methodGetDump(Boolean)
Provides a formatted string representing this object.
Public methodGetFloat
Returns the element corresponding to the specified key as a floating point number.
Public methodGetFloatArray
Returns the element corresponding to the specified key as an array of floats.
Public methodGetHexDump
Provides a detailed hexadecimal representation of this object.
Public methodGetInt
Returns the element corresponding to the specified key as an integer (32 bits).
Public methodGetIntArray
Returns the element corresponding to the specified key as an array of integers.
Public methodGetKeys
Retrieves a list of all the keys contained in this object.
Public methodGetLong
Returns the element corresponding to the specified key as a long integer (64 bits).
Public methodGetLongArray
Returns the element corresponding to the specified key as an array of longs.
Public methodGetSFSArray
Returns the element corresponding to the specified key as an ISFSArray object.
Public methodGetSFSObject
Returns the element corresponding to the specified key as an ISFSObject object.
Public methodGetShort
Returns the element corresponding to the specified key as a short integer (16 bits).
Public methodGetShortArray
Returns the element corresponding to the specified key as an array of shorts.
Public methodGetText
Returns the element corresponding to the specified key as an UTF-8 string, with max length of 2 GBytes.
Public methodGetUtfString
Returns the element corresponding to the specified key as an UTF-8 string, with max length of 32 KBytes.
Public methodGetUtfStringArray
Returns the element corresponding to the specified key as an array of UTF-8 strings.
Public methodIsNull
Indicates if the value mapped by the specified key is null.
Public methodPutBool
Associates the passed boolean value with the specified key in this object.
Public methodPutBoolArray
Associates the passed array of booleans with the specified key in this object.
Public methodPutByte
Associates the passed byte value with the specified key in this object.
Public methodPutByteArray
Associates the passed ByteArray object with the specified key in this object.
Public methodPutClass
Associates the passed custom class instance with the specified key in this object.
Public methodPutDouble
Associates the passed double value with the specified key in this object.
Public methodPutDoubleArray
Associates the passed array of doubles with the specified key in this object.
Public methodPutFloat
Associates the passed float value with the specified key in this object.
Public methodPutFloatArray
Associates the passed array of floats with the specified key in this object.
Public methodPutInt
Associates the passed integer value with the specified key in this object.
Public methodPutIntArray
Associates the passed array of integers with the specified key in this object.
Public methodPutLong
Associates the passed long value with the specified key in this object.
Public methodPutLongArray
Associates the passed array of longs with the specified key in this object.
Public methodPutSFSArray
Associates the passed ISFSArray object with the specified key in this object.
Public methodPutSFSObject
Associates the passed ISFSObject object with the specified key in this object.
Public methodPutShort
Associates the passed short value with the specified key in this object.
Public methodPutShortArray
Associates the passed array of shorts with the specified key in this object.
Public methodPutText
Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object.
Public methodPutUtfString
Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object.
Public methodPutUtfStringArray
Associates the passed array of UTF-8 strings with the specified key in this object.
Public methodRemoveElement
Removes the element corresponding to the passed key from this object.
Public methodSize
Indicates the number of elements in this object.
Public methodToBinary
Provides the binary form of this object.
Public methodToJson
Provides the JSON representation of this object.
Top
Remarks
Read the implementor class description for additional informations.

Check the SFSDataType enumeration for more informations on supported data types.

See Also