com.silanis.esl.sdk.service

Class GroupService

java.lang.Object

com.silanis.esl.sdk.service.GroupService

public class GroupService
extends Object

Constructor Summary

Constructors

Constructor and Description
GroupService(RestClient client, String baseUrl)

Method Summary

Modifier and Type	Method and Description
GroupMember	addMember(GroupId groupId, GroupMember groupMember) Invite a new sender to the group.
Group	createGroup(Group group) Create a new group belonging to this account.
void	deleteGroup(GroupId groupId) Delete a group belonging to this account, specified by GroupId
Group	getGroup(GroupId groupId) Retrieve a single group belonging to this account, specified by GroupId.
List<String>	getGroupMemberEmails(GroupId groupId) Retrieve a list of emails for all members of a group belonging to this account, specified by GroupId.
List<GroupMember>	getGroupMembers(GroupId groupId) Retrieve a list of all members of a group belonging to this account, specified by GroupId.
List<GroupSummary>	getGroupSummaries() Retrieve summaries for all groups for the current account.
List<Group>	getMyGroups() Get a list of all groups belong to the account under which the requests are being issued.
List<Group>	getMyGroups(String groupName) Retrieve group(s) belonging to the account by specifying complete (or part of) GroupName.
Group	inviteMember(GroupId groupId, GroupMember groupMember) Invite a new sender to the group.
Group	updateGroup(Group group, GroupId groupId) Update a group belonging to this account

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupService

public GroupService(RestClient client,
                    String baseUrl)

Method Detail

getMyGroups

public List<Group> getMyGroups()

Get a list of all groups belong to the account under which the requests are being issued.

Returns:

getMyGroups

public List<Group> getMyGroups(String groupName)

Retrieve group(s) belonging to the account by specifying complete (or part of) GroupName.

Parameters:

groupName -

Returns:

getGroup

public Group getGroup(GroupId groupId)

Retrieve a single group belonging to this account, specified by GroupId.

Parameters:

groupId -

Returns:

createGroup

public Group createGroup(Group group)

Create a new group belonging to this account.

Parameters:

group -

Returns:

updateGroup

public Group updateGroup(Group group,
                         GroupId groupId)

Update a group belonging to this account

Parameters:

group -

Returns:

addMember

public GroupMember addMember(GroupId groupId,
                             GroupMember groupMember)

Invite a new sender to the group. Can be used to add a new member to a group.

Parameters:

groupId -

groupMember -

Returns:

The group member

inviteMember

public Group inviteMember(GroupId groupId,
                          GroupMember groupMember)

Invite a new sender to the group. Can be used to add a new member to a group.

Parameters:

groupId -

groupMember -

Returns:

The group with the new member

deleteGroup

public void deleteGroup(GroupId groupId)

Delete a group belonging to this account, specified by GroupId

Parameters:

groupId -

getGroupMemberEmails

public List<String> getGroupMemberEmails(GroupId groupId)

Retrieve a list of emails for all members of a group belonging to this account, specified by GroupId.

Parameters:

groupId -

Returns:

Null if the group doesn't exist, otherwise a list of all group member emails.

getGroupMembers

public List<GroupMember> getGroupMembers(GroupId groupId)

Retrieve a list of all members of a group belonging to this account, specified by GroupId.

Parameters:

groupId -

Returns:

Null if the group doesn't exist, the group's members otherwise.

getGroupSummaries

public List<GroupSummary> getGroupSummaries()

Retrieve summaries for all groups for the current account.

Returns:

summaries for all groups for the current account.