com.dropbox.core.v2.team

Class MembersListBuilder

java.lang.Object

com.dropbox.core.v2.team.MembersListBuilder

public class MembersListBuilder
extends Object

The request builder returned by DbxTeamTeamRequests.membersListBuilder().

Use this class to set optional request parameters and complete the request.

Method Summary

Modifier and Type	Method and Description
MembersListResult	start() Issues the request.
MembersListBuilder	withIncludeRemoved(Boolean includeRemoved) Set value for optional field.
MembersListBuilder	withLimit(Long limit) Set value for optional field.

Methods inherited from class java.lang.Object

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

Method Detail

withLimit

public MembersListBuilder withLimit(Long limit)

Set value for optional field.

If left unset or set to null, defaults to 1000L.

Parameters:

limit - Number of results to return per call. Must be greater than or equal to 1 and be less than or equal to 1000. Defaults to 1000L when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withIncludeRemoved

public MembersListBuilder withIncludeRemoved(Boolean includeRemoved)

Set value for optional field.

If left unset or set to null, defaults to false.

Parameters:

includeRemoved - Whether to return removed members. Defaults to false when set to null.

Returns:

this builder

start

public MembersListResult start()
                        throws MembersListErrorException,
                               DbxException

Issues the request.

Throws:

MembersListErrorException

DbxException