engineer.nightowl.groupsio.api.resource

Class MemberResource

java.lang.Object

engineer.nightowl.groupsio.api.resource.BaseResource

engineer.nightowl.groupsio.api.resource.MemberResource

public class MemberResource
extends BaseResource

Field Summary

Fields inherited from class engineer.nightowl.groupsio.api.resource.BaseResource

apiClient, baseUrl, MAX_RESULTS, OM

Constructor Summary

Constructors

Constructor and Description
MemberResource(GroupsIOApiClient apiClient, String baseUrl)

Method Summary

Modifier and Type	Method and Description
Subscription	approveMember(Integer groupId, Integer subscriptionId) Approve a member to a group
Subscription	banMember(Integer groupId, Integer subscriptionId) Ban a member if they aren't already banned
void	directAddMember(Integer groupId, List<String> emails) Add members directly to a group
Subscription	getMemberInGroup(Integer groupId, Integer memberId) Gets a user's Subscription for the specified group and member IDs
List<Subscription>	getMembersInGroup(Integer groupId) Gets a list of members (represented by Subscription) subscribed to a particular group.
void	inviteMember()
Subscription	removeMember(Integer groupId, Integer subscriptionId) Remove a member from a group
List<Subscription>	searchMembers(Integer groupId, String query) Gets a list of members (represented by Subscription) subscribed to a particular group.
Subscription	sendBounceProbe(Integer groupId, Integer subscriptionId) Send a bounce probe to a user if they are bouncing
Subscription	sendConfirmationEmail(Integer groupId, Integer subscriptionId) Send a confirmation email to a user if they are not yet confirmed
Subscription	updateMember(Subscription subscription) Update a subscription to a group given a blank Subscription object with only the updated fields set.

Methods inherited from class engineer.nightowl.groupsio.api.resource.BaseResource

callApi, callApi, login

Methods inherited from class java.lang.Object

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

Constructor Detail

MemberResource

public MemberResource(GroupsIOApiClient apiClient,
                      String baseUrl)

Method Detail

getMemberInGroup

public Subscription getMemberInGroup(Integer groupId,
                                     Integer memberId)
                              throws URISyntaxException,
                                     IOException,
                                     GroupsIOApiException

Gets a user's Subscription for the specified group and member IDs

Returns:

the user's Subscription for the specified group ID

Throws:

URISyntaxException

IOException

GroupsIOApiException

getMembersInGroup

public List<Subscription> getMembersInGroup(Integer groupId)
                                     throws URISyntaxException,
                                            IOException,
                                            GroupsIOApiException

Gets a list of members (represented by Subscription) subscribed to a particular group.

Parameters:

groupId - - which group to get members from

Returns:

List<Subscription> representing the subscribed members

Throws:

URISyntaxException

IOException

GroupsIOApiException

searchMembers

public List<Subscription> searchMembers(Integer groupId,
                                        String query)
                                 throws URISyntaxException,
                                        IOException,
                                        GroupsIOApiException

Gets a list of members (represented by Subscription) subscribed to a particular group.

Parameters:

groupId - - which group to get members from

query - - what to search for (will search over email or name)

Returns:

List<Subscription> representing the subscribed members

Throws:

URISyntaxException

IOException

GroupsIOApiException

updateMember

public Subscription updateMember(Subscription subscription)
                          throws URISyntaxException,
                                 IOException,
                                 GroupsIOApiException

Update a subscription to a group given a blank Subscription object with only the updated fields set. Example:

 final Subscription subToUpdate = new Subscription();
 subToUpdate.setAutoFollowReplies(true);
 final Subscription updateSub = client.member().updateMember(subToUpdate);
 

Parameters:

subscription - - with only the updated fields set

Returns:

the full Subscription after a successful update

Throws:

URISyntaxException

IOException

GroupsIOApiException

banMember

public Subscription banMember(Integer groupId,
                              Integer subscriptionId)
                       throws URISyntaxException,
                              IOException,
                              GroupsIOApiException

Ban a member if they aren't already banned

Parameters:

groupId - of the group they belong to

subscriptionId - of the subscription they have

Returns:

the user's Subscription

Throws:

URISyntaxException

IOException

GroupsIOApiException

approveMember

public Subscription approveMember(Integer groupId,
                                  Integer subscriptionId)
                           throws URISyntaxException,
                                  IOException,
                                  GroupsIOApiException

Approve a member to a group

Parameters:

groupId - of the group they should belong to

subscriptionId - of the subscription they have

Returns:

the user's Subscription

Throws:

URISyntaxException

IOException

GroupsIOApiException

directAddMember

public void directAddMember(Integer groupId,
                            List<String> emails)
                     throws URISyntaxException,
                            IOException,
                            GroupsIOApiException

Add members directly to a group

Parameters:

groupId - of the group they should be added to

emails - a list of email address to add.

Throws:

URISyntaxException

IOException

GroupsIOApiException

inviteMember

public void inviteMember()

removeMember

public Subscription removeMember(Integer groupId,
                                 Integer subscriptionId)
                          throws URISyntaxException,
                                 IOException,
                                 GroupsIOApiException

Remove a member from a group

Parameters:

groupId - of the group they belong to

subscriptionId - of the subscription they have

Returns:

the user's Subscription

Throws:

URISyntaxException

IOException

GroupsIOApiException

sendBounceProbe

public Subscription sendBounceProbe(Integer groupId,
                                    Integer subscriptionId)
                             throws URISyntaxException,
                                    IOException,
                                    GroupsIOApiException

Send a bounce probe to a user if they are bouncing

Parameters:

groupId - of the group they belong to

subscriptionId - of the subscription they have

Returns:

the user's Subscription

Throws:

URISyntaxException

IOException

GroupsIOApiException

sendConfirmationEmail

public Subscription sendConfirmationEmail(Integer groupId,
                                          Integer subscriptionId)
                                   throws URISyntaxException,
                                          IOException,
                                          GroupsIOApiException

Send a confirmation email to a user if they are not yet confirmed

Parameters:

groupId - of the group they belong to

subscriptionId - of the subscription they have

Returns:

the user's Subscription

Throws:

URISyntaxException

IOException

GroupsIOApiException