User/Group#

Functions#

OmniClientRequestId omniClientAddUserToGroup(char const *url, const char *user, const char *group, void *userData, OmniClientAddUserToGroupCallback callback): Add user to a group.
OmniClientRequestId omniClientCreateGroup(char const *url, const char *group, void *userData, OmniClientCreateGroupCallback callback): Create a group on server.
OmniClientRequestId omniClientGetGroupUsers(char const *url, const char *group, void *userData, OmniClientGetGroupUsersCallback callback): Returns a list of users associated with a group.
OmniClientRequestId omniClientGetGroups(char const *url, void *userData, OmniClientGetGroupsCallback callback): Returns a list of all groups registered with the server.
OmniClientRequestId omniClientGetUserGroups(char const *url, const char *user, void *userData, OmniClientGetUserGroupsCallback callback): Returns all groups a user belongs to.
OmniClientRequestId omniClientGetUsers(char const *url, void *userData, OmniClientGetUsersCallback callback): Returns all users registered with the server.
OmniClientRequestId omniClientRemoveGroup(char const *url, const char *group, void *userData, OmniClientRemoveGroupCallback callback): Remove group from server.
OmniClientRequestId omniClientRemoveUserFromGroup(char const *url, const char *user, const char *group, void *userData, OmniClientRemoveUserFromGroupCallback callback): Remove user from a group.
OmniClientRequestId omniClientRenameGroup(char const *url, const char *group, const char *newGroup, void *userData, OmniClientRenameGroupCallback callback): Rename group on server.

Typedefs#

OmniClientAddUserToGroupCallback: This is called with the result of omniClientAddUserToGroup .
OmniClientCreateGroupCallback: This is called with the result of omniClientCreateGroup .
OmniClientGetGroupUsersCallback: This is called with the result of omniClientGetGroupUsers .
OmniClientGetGroupsCallback: This is called with the result of omniClientGetGroups .
OmniClientGetUserGroupsCallback: This is called with the result of omniClientGetUserGroups .
OmniClientGetUsersCallback: This is called with the result of omniClientGetUsers .
OmniClientRemoveGroupCallback: This is called with the result of omniClientRemoveGroup .
OmniClientRemoveUserFromGroupCallback: This is called with the result of omniClientRemoveUserFromGroup .
OmniClientRenameGroupCallback: This is called with the result of omniClientRenameGroup .

Functions#

OmniClientRequestId omniClientAddUserToGroup( char const *url, const char *user, const char *group, void *userData, OmniClientAddUserToGroupCallback callback, )#

Add user to a group.

Parameters:

url – The URL of the server to add the user to the group on
user – The name of the user to add
group – The name of the group to add the user to
userData – User data passed to the callback
callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientCreateGroup( char const *url, const char *group, void *userData, OmniClientCreateGroupCallback callback, )#

Create a group on server.

Parameters:

url – The URL of the server to create the group on
group – The name of the group to create
userData – User data passed to the callback
callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientGetGroupUsers( char const *url, const char *group, void *userData, OmniClientGetGroupUsersCallback callback, )#

Returns a list of users associated with a group.

Parameters:

url – The URL of the server to get group users from
group – The name of the group to get users for
userData – User data passed to the callback
callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientGetGroups( char const *url, void *userData, OmniClientGetGroupsCallback callback, )#

Returns a list of all groups registered with the server.

Parameters:

url – The URL of the server to get groups from
userData – User data passed to the callback
callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientGetUserGroups( char const *url, const char *user, void *userData, OmniClientGetUserGroupsCallback callback, )#

Returns all groups a user belongs to.

Parameters:

url – The URL of the server to get user groups from
user – The name of the user to get groups for
userData – User data passed to the callback
callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientGetUsers( char const *url, void *userData, OmniClientGetUsersCallback callback, )#

Returns all users registered with the server.

Parameters:

url – The URL of the server to get users from
userData – User data passed to the callback
callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientRemoveGroup( char const *url, const char *group, void *userData, OmniClientRemoveGroupCallback callback, )#

Remove group from server.

Parameters:

url – The URL of the server to remove the group from
group – The name of the group to remove
userData – User data passed to the callback
callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientRemoveUserFromGroup( char const *url, const char *user, const char *group, void *userData, OmniClientRemoveUserFromGroupCallback callback, )#

Remove user from a group.

Parameters:

url – The URL of the server to remove the user from the group on
user – The name of the user to remove
group – The name of the group to remove the user from
userData – User data passed to the callback
callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

OmniClientRequestId omniClientRenameGroup( char const *url, const char *group, const char *newGroup, void *userData, OmniClientRenameGroupCallback callback, )#

Rename group on server.

Parameters:

url – The URL of the server to rename the group on
group – The current name of the group
newGroup – The new name for the group
userData – User data passed to the callback
callback – The callback function to register

Returns:

A request ID that can be used with omniClientStop

Typedefs#

typedef void (*OmniClientAddUserToGroupCallback)(void *userData, OmniClientResult result)#: This is called with the result of omniClientAddUserToGroup.

typedef void (*OmniClientCreateGroupCallback)(void *userData, OmniClientResult result)#: This is called with the result of omniClientCreateGroup.

typedef void (*OmniClientGetGroupUsersCallback)(void *userData, OmniClientResult result, uint64_t count, const char **users)#: This is called with the result of omniClientGetGroupUsers.

typedef void (*OmniClientGetGroupsCallback)(void *userData, OmniClientResult result, uint64_t count, const char **groups)#: This is called with the result of omniClientGetGroups.

typedef void (*OmniClientGetUserGroupsCallback)(void *userData, OmniClientResult result, uint64_t count, const char **groups)#: This is called with the result of omniClientGetUserGroups.

typedef void (*OmniClientGetUsersCallback)(void *userData, OmniClientResult result, uint64_t count, const char **users)#: This is called with the result of omniClientGetUsers.

typedef void (*OmniClientRemoveGroupCallback)(void *userData, OmniClientResult result, uint64_t changeCount)#: This is called with the result of omniClientRemoveGroup.

typedef void (*OmniClientRemoveUserFromGroupCallback)(void *userData, OmniClientResult result)#: This is called with the result of omniClientRemoveUserFromGroup.

typedef void (*OmniClientRenameGroupCallback)(void *userData, OmniClientResult result)#: This is called with the result of omniClientRenameGroup.