Package com.github.jamesnetherton.zulip.client.api.user.request

Class GetUserGroupMembershipStatusApiRequest

java.lang.Object

com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

com.github.jamesnetherton.zulip.client.api.user.request.GetUserGroupMembershipStatusApiRequest

All Implemented Interfaces:

ExecutableApiRequest<Boolean>

public class GetUserGroupMembershipStatusApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Boolean>

Check whether a user is member of user group.

See Also:

• https://zulip.com/api/get-is-user-group-member

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DIRECT_MEMBER_ONLY

Constructor Summary

Constructors

Constructor	Description
GetUserGroupMembershipStatusApiRequest(ZulipHttpClient client, long userGroupId, long userId)	Constructs a GetUserGroupMembershipStatusApiRequest.

Method Summary

Modifier and Type	Method	Description
Boolean	execute()	Executes the Zulip API request for getting members of a user group.
GetUserGroupMembershipStatusApiRequest	withDirectMemberOnly(boolean isDirectMemberOnly)	Sets Whether to consider only the direct members of user group.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DIRECT_MEMBER_ONLY

public static final String DIRECT_MEMBER_ONLY

See Also:

• Constant Field Values

Constructor Details

GetUserGroupMembershipStatusApiRequest

public GetUserGroupMembershipStatusApiRequest(ZulipHttpClient client,
 long userGroupId,
 long userId)

Constructs a GetUserGroupMembershipStatusApiRequest.

Parameters:

client - The Zulip HTTP client

userGroupId - The id of the user group

userId - The id of the user

Method Details

withDirectMemberOnly

public GetUserGroupMembershipStatusApiRequest withDirectMemberOnly(boolean isDirectMemberOnly)

Sets Whether to consider only the direct members of user group.

Parameters:

isDirectMemberOnly - true to consider only direct members of the user group. false to not consider direct members of the user group

Returns:

This GetUserGroupMembershipStatusApiRequest instance

execute

public Boolean execute()
                throws ZulipClientException

Executes the Zulip API request for getting members of a user group.

Specified by:

execute in interface ExecutableApiRequest<Boolean>

Returns:

Whether the user is a member of the specified group

Throws:

ZulipClientException - if the request was not successful