admin  directory_v1
Classes | Public Member Functions | List of all members
Google.Apis.Admin.Directory.directory_v1.MembersResource Class Reference

The "members" collection of methods. More...

Classes

class  DeleteRequest
 Remove membership. More...
 
class  GetRequest
 Retrieve Group Member More...
 
class  HasMemberRequest
 Checks whether the given user is a member of the group. Membership can be direct or nested. More...
 
class  InsertRequest
 Add user to the specified group. More...
 
class  ListRequest
 Retrieve all members in a group (paginated) More...
 
class  PatchRequest
 Update membership of a user in the specified group. This method supports patch semantics. More...
 
class  UpdateRequest
 Update membership of a user in the specified group. More...
 

Public Member Functions

 MembersResource (Google.Apis.Services.IClientService service)
 Constructs a new resource. More...
 
virtual DeleteRequest Delete (string groupKey, string memberKey)
 Remove membership. More...
 
virtual GetRequest Get (string groupKey, string memberKey)
 Retrieve Group Member More...
 
virtual HasMemberRequest HasMember (string groupKey, string memberKey)
 Checks whether the given user is a member of the group. Membership can be direct or nested. More...
 
virtual InsertRequest Insert (Google.Apis.Admin.Directory.directory_v1.Data.Member body, string groupKey)
 Add user to the specified group. More...
 
virtual ListRequest List (string groupKey)
 Retrieve all members in a group (paginated) More...
 
virtual PatchRequest Patch (Google.Apis.Admin.Directory.directory_v1.Data.Member body, string groupKey, string memberKey)
 Update membership of a user in the specified group. This method supports patch semantics. More...
 
virtual UpdateRequest Update (Google.Apis.Admin.Directory.directory_v1.Data.Member body, string groupKey, string memberKey)
 Update membership of a user in the specified group. More...
 

Detailed Description

The "members" collection of methods.

Constructor & Destructor Documentation

◆ MembersResource()

Google.Apis.Admin.Directory.directory_v1.MembersResource.MembersResource ( Google.Apis.Services.IClientService  service)
inline

Constructs a new resource.

Member Function Documentation

◆ Delete()

virtual DeleteRequest Google.Apis.Admin.Directory.directory_v1.MembersResource.Delete ( string  groupKey,
string  memberKey 
)
inlinevirtual

Remove membership.

Parameters
groupKeyEmail or immutable ID of the group
memberKeyEmail or immutable ID of the member

◆ Get()

virtual GetRequest Google.Apis.Admin.Directory.directory_v1.MembersResource.Get ( string  groupKey,
string  memberKey 
)
inlinevirtual

Retrieve Group Member

Parameters
groupKeyEmail or immutable ID of the group
memberKeyEmail or immutable ID of the member

◆ HasMember()

virtual HasMemberRequest Google.Apis.Admin.Directory.directory_v1.MembersResource.HasMember ( string  groupKey,
string  memberKey 
)
inlinevirtual

Checks whether the given user is a member of the group. Membership can be direct or nested.

Parameters
groupKeyIdentifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
memberKeyIdentifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.

◆ Insert()

virtual InsertRequest Google.Apis.Admin.Directory.directory_v1.MembersResource.Insert ( Google.Apis.Admin.Directory.directory_v1.Data.Member  body,
string  groupKey 
)
inlinevirtual

Add user to the specified group.

Parameters
bodyThe body of the request.
groupKeyEmail or immutable ID of the group

◆ List()

virtual ListRequest Google.Apis.Admin.Directory.directory_v1.MembersResource.List ( string  groupKey)
inlinevirtual

Retrieve all members in a group (paginated)

Parameters
groupKeyEmail or immutable ID of the group

◆ Patch()

virtual PatchRequest Google.Apis.Admin.Directory.directory_v1.MembersResource.Patch ( Google.Apis.Admin.Directory.directory_v1.Data.Member  body,
string  groupKey,
string  memberKey 
)
inlinevirtual

Update membership of a user in the specified group. This method supports patch semantics.

Parameters
bodyThe body of the request.
groupKeyEmail or immutable ID of the group. If ID, it should match with id of group object
memberKeyEmail or immutable ID of the user. If ID, it should match with id of member object

◆ Update()

virtual UpdateRequest Google.Apis.Admin.Directory.directory_v1.MembersResource.Update ( Google.Apis.Admin.Directory.directory_v1.Data.Member  body,
string  groupKey,
string  memberKey 
)
inlinevirtual

Update membership of a user in the specified group.

Parameters
bodyThe body of the request.
groupKeyEmail or immutable ID of the group. If ID, it should match with id of group object
memberKeyEmail or immutable ID of the user. If ID, it should match with id of member object

The documentation for this class was generated from the following file: