UserManGroupAPI

Interface suitable for manipulating group information

interface UserManGroupAPI {

struct CollectionIndices;

Collection!UserManGroupMemberAPI members(string _group);

long count [@property getter];

void create(string name, string description);

void remove(string _group);

void setDescription(string _group, string description);

Group get(string _group);

Group[] getRange(long first_group, long max_count);

}

Members

Functions

create void create(string name, string description): Creates a new group.
get Group get(string _group): Gets information about a group using its name as the identifier.
getRange Group[] getRange(long first_group, long max_count): Gets a range of groups, suitable for pagination.
members Collection!UserManGroupMemberAPI members(string _group): Undocumented in source.
remove void remove(string _group): Removes a group.
setDescription void setDescription(string _group, string description): Gets information about an existing group. Sets the description of a group.

Properties

count long count [@property getter]: The total number of groups.

Structs

CollectionIndices struct CollectionIndices: Undocumented in source.

Meta

Source

See Implementation

userman api classes

UserManAPISettings

functions

interfaces

structs