Members
(readonly) userCount :number
Total number of Users in the local User List.
Type:
- number
(readonly) userList :Array.<SFSUser>
List of SFSUser objects representing the Users in the local User List.
Type:
- Array.<SFSUser>
Methods
containsUser(user) → {boolean}
Indicates whether the specified User exists in the local User List.
Parameters:
| Name | Type | Description |
|---|---|---|
user | SFSUser | The object representing the User whose presence in the User List should be checked. |
Returns:
true if the passed User is found in the User List.- Type:
- boolean
containsUserId(id) → {boolean}
Indicates whether the specified User exists in the local User List.
Parameters:
| Name | Type | Description |
|---|---|---|
id | number | The id of the User whose presence in the User List should be checked. |
- See
Returns:
true if a User with the passed id is found in the User List.- Type:
- boolean
containsUserName(name) → {boolean}
Indicates whether the specified User exists in the local User List.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string | The name of the User whose presence in the User List should be checked. |
- See
Returns:
true if a User with the passed name id found in the User List.- Type:
- boolean
getUserById(id) → {SFSUser}
Retrieves a SFSUser object by its id.
Parameters:
| Name | Type | Description |
|---|---|---|
id | number | The id of the User. |
- See
Returns:
The object representing the User, or
null if no User with the passed id can be found in the local User List.- Type:
- SFSUser
getUserByName(name) → {SFSUser}
Retrieves a SFS by its name.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string | The name of the User. |
- See
Returns:
The object representing the User, or
null if no User with the passed name can be found in the local User List.- Type:
- SFSUser