Console
    Contact Us Start free

    Google Apps Chat V1 Client - Class ListMembershipsRequest (0.12.0)

    Reference documentation and code samples for the Google Apps Chat V1 Client class ListMembershipsRequest.

    Request message for listing memberships.

    Generated from protobuf message google.chat.v1.ListMembershipsRequest

    Namespace

    Google \ Apps \ Chat \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ parent
    string

    Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}

    ↳ page_size
    int

    Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an INVALID_ARGUMENT error.

    ↳ page_token
    string

    Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

    ↳ filter
    string

    Optional. A query filter. You can filter memberships by a member's role ( role ) and type ( member.type ). To filter by role, set role to ROLE_MEMBER or ROLE_MANAGER . To filter by type, set member.type to HUMAN or BOT . You can also filter for member.type using the != operator. To filter by both role and type, use the AND operator. To filter by either role or type, use the OR operator. Either member.type = "HUMAN" or member.type != "BOT" is required when use_admin_access is set to true. Other member type filters will be rejected. For example, the following queries are valid: role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT" The following queries are invalid: member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

    ↳ show_groups
    bool

    Optional. When true , also returns memberships associated with a Google Group , in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.

    ↳ show_invited
    bool

    Optional. When true , also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires user authentication .

    ↳ use_admin_access
    bool

    Optional. When true , the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires either the chat.admin.memberships.readonly or chat.admin.memberships OAuth 2.0 scope . Listing app memberships in a space isn't supported when using admin access.

    getParent

    Required. The resource name of the space for which to fetch a membership list.

    Format: spaces/{space}

    Returns
    Type
    Description
    string

    setParent

    Required. The resource name of the space for which to fetch a membership list.

    Format: spaces/{space}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPageSize

    Optional. The maximum number of memberships to return. The service might return fewer than this value.

    If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an INVALID_ARGUMENT error.

    Returns
    Type
    Description
    int

    setPageSize

    Optional. The maximum number of memberships to return. The service might return fewer than this value.

    If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an INVALID_ARGUMENT error.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getPageToken

    Optional. A page token, received from a previous call to list memberships.

    Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

    Returns
    Type
    Description
    string

    setPageToken

    Optional. A page token, received from a previous call to list memberships.

    Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFilter

    Optional. A query filter.

    You can filter memberships by a member's role ( role ) and type ( member.type ). To filter by role, set role to ROLE_MEMBER or ROLE_MANAGER . To filter by type, set member.type to HUMAN or BOT . You can also filter for member.type using the != operator. To filter by both role and type, use the AND operator. To filter by either role or type, use the OR operator. Either member.type = "HUMAN" or member.type != "BOT" is required when use_admin_access is set to true. Other member type filters will be rejected. For example, the following queries are valid:

     role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"
member.type != "BOT"

    The following queries are invalid:

     member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

    Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

    Returns
    Type
    Description
    string

    setFilter

    Optional. A query filter.

    You can filter memberships by a member's role ( role ) and type ( member.type ). To filter by role, set role to ROLE_MEMBER or ROLE_MANAGER . To filter by type, set member.type to HUMAN or BOT . You can also filter for member.type using the != operator. To filter by both role and type, use the AND operator. To filter by either role or type, use the OR operator. Either member.type = "HUMAN" or member.type != "BOT" is required when use_admin_access is set to true. Other member type filters will be rejected. For example, the following queries are valid:

     role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"
member.type != "BOT"

    The following queries are invalid:

     member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

    Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getShowGroups

    Optional. When true , also returns memberships associated with a Google Group , in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.

    Returns
    Type
    Description
    bool

    setShowGroups

    Optional. When true , also returns memberships associated with a Google Group , in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getShowInvited

    Optional. When true , also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned.

    Currently requires user authentication .

    Returns
    Type
    Description
    bool

    setShowInvited

    Optional. When true , also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned.

    Currently requires user authentication .

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getUseAdminAccess

    Optional. When true , the method runs using the user's Google Workspace administrator privileges.

    The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires either the chat.admin.memberships.readonly or chat.admin.memberships OAuth 2.0 scope . Listing app memberships in a space isn't supported when using admin access.

    Returns
    Type
    Description
    bool

    setUseAdminAccess

    Optional. When true , the method runs using the user's Google Workspace administrator privileges.

    The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires either the chat.admin.memberships.readonly or chat.admin.memberships OAuth 2.0 scope . Listing app memberships in a space isn't supported when using admin access.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    static::build

    Parameter
    Name
    Description
    parent
    string

    Required. The resource name of the space for which to fetch a membership list.

    Format: spaces/{space} Please see ChatServiceClient::spaceName() for help formatting this field.

    Returns
    Type
    Description
    ListMembershipsRequest
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: