engineer.nightowl.groupsio.api

Class GroupsIOApiClient

java.lang.Object

engineer.nightowl.groupsio.api.GroupsIOApiClient

public class GroupsIOApiClient
extends Object

Main interface with Groups.io. Actions will be carried out in the context of the user you login with. If you receive an GroupsIOApiExceptionType.INADEQUATE_PERMISSIONS error, you need to use a user who mods/owns a group. If you are integrating to manage one or more groups rather than creating a generic application for use by any user, consider creating a 'processing' user with mod/owner permissions just for use with the API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_API_BASE
static String	DEFAULT_DOMAIN
static org.apache.http.HttpHost	DEFAULT_HOST
static String	DEFAULT_HOSTNAME
static String	DEFAULT_SCHEME
static String	DEFAULT_VERSION
static String	DEFAULT_VERSIONED_API_BASE

Constructor Summary

Constructors

Constructor and Description
GroupsIOApiClient(String apiKey, String email) Common client initialisation.
GroupsIOApiClient(String hostname, String version, String apiKey, String email, String domain, Integer twoFactor) More in-depth constructor to override the defaults.

Method Summary

Modifier and Type	Method and Description
ArchiveResource	archive() Actions involving message archives.
String	getApiKey()
String	getApiToken()
String	getDomain()
String	getEmail()
Integer	getTwoFactor()
GroupResource	group() Actions involving a specific group.
MemberResource	member() Actions involving the members of a group.
void	setApiToken(String apiToken)
UserResource	user() Actions involving the currently authenticated user.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOSTNAME

public static final String DEFAULT_HOSTNAME

See Also:

Constant Field Values

DEFAULT_SCHEME

public static final String DEFAULT_SCHEME

See Also:

Constant Field Values

DEFAULT_HOST

public static final org.apache.http.HttpHost DEFAULT_HOST

DEFAULT_API_BASE

public static final String DEFAULT_API_BASE

DEFAULT_VERSION

public static final String DEFAULT_VERSION

See Also:

Constant Field Values

DEFAULT_VERSIONED_API_BASE

public static final String DEFAULT_VERSIONED_API_BASE

DEFAULT_DOMAIN

public static final String DEFAULT_DOMAIN

See Also:

Constant Field Values

Constructor Detail

GroupsIOApiClient

public GroupsIOApiClient(String apiKey,
                         String email)

Common client initialisation. Provide your API key and email.

Parameters:

apiKey - - TODO: Update with details once published.

email - - the email of the user to log in as

GroupsIOApiClient

public GroupsIOApiClient(String hostname,
                         String version,
                         String apiKey,
                         String email,
                         String domain,
                         Integer twoFactor)

More in-depth constructor to override the defaults.

Parameters:

hostname - - the base hostname (e.g. api.groups.io) to use

version - - the API version (e.g. v1) to use

apiKey - - TODO: Update with details once published.

email - - the email of the user to log in as

domain - - the domain name to connect with

twoFactor - - the appropriate two-factor code to use

Method Detail

user

public UserResource user()

Actions involving the currently authenticated user.

Returns:

UserResource

member

public MemberResource member()

Actions involving the members of a group.

Returns:

MemberResource

group

public GroupResource group()

Actions involving a specific group.

Returns:

GroupResource

archive

public ArchiveResource archive()

Actions involving message archives.

Returns:

ArchiveResource

setApiToken

public void setApiToken(String apiToken)

Parameters:

apiToken - set the apiToken

getApiKey

public String getApiKey()

Returns:

the apiKey

getEmail

public String getEmail()

Returns:

the email

getDomain

public String getDomain()

Returns:

the domain

getTwoFactor

public Integer getTwoFactor()

Returns:

the twoFactor

getApiToken

public String getApiToken()

Returns:

the apiToken