connectycube_custom_objects
library
Functions
-
createCustomObject(CubeCustomObject customObject)
→ Future<CubeCustomObject>
-
Returns created object
-
createSession([CubeUser? cubeUser])
→ Future<CubeSession>
-
-
createSessionUsingFirebase(String projectId, String accessToken)
→ Future<CubeSession>
-
-
createSessionUsingFirebaseEmail(String projectId, String accessToken)
→ Future<CubeSession>
-
-
createSessionUsingFirebasePhone(String projectId, String accessToken)
→ Future<CubeSession>
-
-
createSessionUsingSocialProvider(String socialProvider, String accessToken, [String? accessTokenSecret])
→ Future<CubeSession>
-
-
deleteCustomObjectById(String className, String id)
→ Future<void>
-
className - name of the class of custom objects which you want to delete
id - id of custom object which you want to delete
-
deleteCustomObjectsByCriteria(String className, [Map<String, dynamic>? params])
→ Future<int>
-
Returns the count of deleted objects
-
deleteCustomObjectsByIds(String className, List<String> ids)
→ Future<DeleteItemsResult?>
-
Returns DeleteItemsResult object with detailed information about deleting result
-
deleteSession()
→ Future<void>
-
-
deleteSessionsExceptCurrent()
→ Future<void>
-
-
deleteUser(int userId)
→ Future<void>
-
-
deleteUserByExternalId(int externalId)
→ Future<void>
-
-
getAddressBook([String? udid])
→ Future<List<CubeContact>?>
-
-
getAllUsers()
→ Future<PagedResult<CubeUser>?>
-
-
getAllUsersByIds(Set<int> ids, {RequestPaginator? paginator, RequestSorter? sorter})
→ Future<PagedResult<CubeUser>?>
-
ids - the set of ids of users you want to get
paginator - the instance of the helper class RequestPaginator that is representing
the pagination parameters in the request. Note: the paginator.page should start from 0.
sorter - the instance of the helper class RequestSorter that is representing
the sorting parameters in the request. The example can be var sorter = RequestSorter.desc('created_at');
-
getCustomObjectById(String className, String id)
→ Future<CubeCustomObject?>
-
Returns custom object with
id
-
getCustomObjectPermissions(String className, String id)
→ Future<CustomObjectPermissionsResult>
-
Returns permissions for requested by
id object
-
getCustomObjectsByClassName(String className, [Map<String, dynamic>? params])
→ Future<PagedCustomObjectResult>
-
Returns list of requested objects
-
getCustomObjectsByIds(String className, List<String> ids)
→ Future<PagedCustomObjectResult>
-
Returns list of requested objects
-
getQueryString(Map params, {String prefix = '&', bool inRecursion = false})
→ String
-
Returns query parameters string, e.g.
application_id=774&auth_key=aY7WwSRmu2-GbfA&nonce=1451135156
This function is more suitable for
php API servers.
Try the getUriQueryString if the server returns errors related to the syntax of the query string
-
getRegisteredUsersFromAddressBook(bool compact, [String? udid])
→ Future<List<CubeUser>?>
-
-
getSession()
→ Future<CubeSession>
-
-
getUriQueryString(Map<String, dynamic> params)
→ String
-
Returns query parameters string, e.g.
application_id=774&auth_key=aY7WwSRmu2-GbfA&nonce=1451135156
The difference between this function from the getQueryString is that this one is based on the
dart specifications
-
getUserByEmail(String email)
→ Future<CubeUser?>
-
-
getUserByExternalId(int externalId)
→ Future<CubeUser?>
-
-
getUserByExternalUserId(String externalUserId)
→ Future<CubeUser?>
-
-
getUserByFacebookId(String facebookId)
→ Future<CubeUser?>
-
-
getUserById(int id)
→ Future<CubeUser?>
-
-
getUserByIdentifier(String identifierName, dynamic identifierValue, {Map<String, dynamic>? additionalParameters})
→ Future<CubeUser?>
-
-
getUserByLogin(String login)
→ Future<CubeUser?>
-
-
getUserByPhoneNumber(String phone)
→ Future<CubeUser?>
-
-
-
getUsers(Map<String, dynamic> parameters, {RequestPaginator? paginator, RequestSorter? sorter})
→ Future<PagedResult<CubeUser>?>
-
The method returns the list according to the specified list of parameters.
The list of available
parameters is provided in the Server API documentation
by link https://developers.connectycube.com/server/users?id=retrieve-users-v2
paginator - the instance of the helper class RequestPaginator that is representing
the pagination parameters in the request. Note: the paginator.page should start from 0.
sorter - the instance of the helper class RequestSorter that is representing
the sorting parameters in the request. The example can be var sorter = RequestSorter.desc('created_at');
-
getUsersByFilter(RequestFilter filter)
→ Future<PagedResult<CubeUser>?>
-
Returns users by the custom filter. Possible filters provided by link https://developers.connectycube.com/server/users?id=parameters-1
For example for getting users by ids you can use the next code snippet:
-
getUsersByFullName(String fullName, {RequestPaginator? paginator, RequestSorter? sorter})
→ Future<PagedResult<CubeUser>?>
-
fullName - the part of the 'fullName' with which the name begins.
paginator - the instance of the helper class RequestPaginator that is representing
the pagination parameters in the request.
Pay attention: the paginator.itemsPerPage should be 5 for this request.
Note: the paginator.page should start from 0.
sorter - the instance of the helper class RequestSorter that is representing
the sorting parameters in the request. The example can be var sorter = RequestSorter.desc('created_at');
-
getUsersByTags(Set<String> tags, {RequestPaginator? paginator, RequestSorter? sorter})
→ Future<PagedResult<CubeUser>?>
-
-
init(String applicationId, String authorizationKey, String authorizationSecret, {Future<CubeSession> onSessionRestore()?})
→ dynamic
-
-
isEmpty(String? string)
→ bool
-
-
isEmptyList<T>(List<T>? list)
→ bool
-
-
log(String? message, [String? tag])
→ dynamic
-
-
logTime(String message, [String? tag])
→ dynamic
-
-
resetPassword(String email)
→ Future<void>
-
-
setEndpoints(String apiEndpoint, String chatEndpoint)
→ dynamic
-
-
signIn(CubeUser user)
→ Future<CubeUser>
-
-
signInByEmail(String email, String password)
→ Future<CubeUser>
-
-
signInByLogin(String login, String password)
→ Future<CubeUser>
-
-
signInUsingFirebase(String projectId, String accessToken)
→ Future<CubeUser>
-
-
signInUsingFirebaseEmail(String projectId, String accessToken)
→ Future<CubeUser>
-
-
signInUsingFirebasePhone(String projectId, String accessToken)
→ Future<CubeUser>
-
-
signInUsingSocialProvider(String socialProvider, String accessToken, [String? accessTokenSecret])
→ Future<CubeUser>
-
-
signOut()
→ Future<void>
-
-
signUp(CubeUser user)
→ Future<CubeUser>
-
-
updateCustomObject(String className, String id, Map<String, dynamic> params)
→ Future<CubeCustomObject>
-
Returns updated object
-
updateCustomObjectsByCriteria(String className, [Map<String, dynamic>? params])
→ Future<PagedCustomObjectResult>
-
Returns list of updated objects
-
updateUser(CubeUser user)
→ Future<CubeUser>
-
-
uploadAddressBook(List<CubeContact> contacts, {bool? force, String? udid})
→ Future<AddressBookResult?>
-
