au.org.ala.userdetails

Interface UserDetailsClient

public interface UserDetailsClient

An interface that represents the exposed web services of the UserDetails application. Use the UserDetailsClient.Builder or Retrofit to generate an instance.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserDetailsClient.Builder A Builder for generating UserDetailsClient instances.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GET_USER_DETAILS_FROM_ID_LIST_PATH
static java.lang.String	GET_USER_DETAILS_PATH
static java.lang.String	GET_USER_LIST_FULL_PATH
static java.lang.String	GET_USER_LIST_PATH
static java.lang.String	GET_USER_LIST_WITH_IDS_PATH

Method Summary

Methods

Modifier and Type	Method and Description
retrofit2.Call<UserDetails>	getUserDetails(java.lang.String username, boolean includeProps) Return a JSON object containing id, email and display name for a given user, use includeProps=true to get additional information such as organisation
retrofit2.Call<UserDetailsFromIdListResponse>	getUserDetailsFromIdList(UserDetailsFromIdListRequest request) return the UserDetails objects for a list of user ids.
retrofit2.Call<java.util.Map<java.lang.String,java.lang.String>>	getUserList() Deprecated.
retrofit2.Call<java.util.List<UserDetails>>	getUserListFull() Deprecated.
retrofit2.Call<java.util.Map<java.lang.String,java.lang.String>>	getUserListWithIds() Deprecated.

Field Detail

GET_USER_DETAILS_PATH

static final java.lang.String GET_USER_DETAILS_PATH

See Also:

Constant Field Values

GET_USER_DETAILS_FROM_ID_LIST_PATH

static final java.lang.String GET_USER_DETAILS_FROM_ID_LIST_PATH

See Also:

Constant Field Values

GET_USER_LIST_FULL_PATH

static final java.lang.String GET_USER_LIST_FULL_PATH

See Also:

Constant Field Values

GET_USER_LIST_PATH

static final java.lang.String GET_USER_LIST_PATH

See Also:

Constant Field Values

GET_USER_LIST_WITH_IDS_PATH

static final java.lang.String GET_USER_LIST_WITH_IDS_PATH

See Also:

Constant Field Values

Method Detail

getUserDetails

@POST(value="userDetails/getUserDetails")
retrofit2.Call<UserDetails> getUserDetails(@Query(value="userName")
                                              java.lang.String username,
                                              @Query(value="includeProps")
                                              boolean includeProps)

Return a JSON object containing id, email and display name for a given user, use includeProps=true to get additional information such as organisation

Parameters:

username - Can be either a numeric id or an email address id

includeProps - True to include extended properties such as organisation, telephone, etc.

Returns:

A call that will return a UserDetails object.

getUserDetailsFromIdList

@POST(value="userDetails/getUserDetailsFromIdList")
retrofit2.Call<UserDetailsFromIdListResponse> getUserDetailsFromIdList(@Body
                                                                          UserDetailsFromIdListRequest request)

return the UserDetails objects for a list of user ids.

Parameters:

request - The request body - accepts numeric ids only.

Returns:

A response object with the matched UserDetails and any missing ids and or error messages.

getUserListFull

@Deprecated
@POST(value="userDetails/getUserListFull")
retrofit2.Call<java.util.List<UserDetails>> getUserListFull()

Deprecated.

Return all the UserDetails. This will be super slow probably so caching the result is advised.

Returns:

A call that returns all the UserDetails.

getUserList

@Deprecated
@POST(value="userDetails/getUserList")
retrofit2.Call<java.util.Map<java.lang.String,java.lang.String>> getUserList()

Deprecated.

Return a map of User email to User display name. Returns all known users.

Returns:

A map of User email to User display name

getUserListWithIds

@Deprecated
@POST(value="userDetails/getUserListWithIds")
retrofit2.Call<java.util.Map<java.lang.String,java.lang.String>> getUserListWithIds()

Deprecated.

Return a map of User numeric id to User display name. Returns all known users.

Returns:

A map of User numeric id to User display name