Package app.knock.api.resources

Class UsersResource

java.lang.Object

app.knock.api.resources.UsersResource

public final class UsersResource
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UsersResource.FeedQueryParams

Constructor Summary

Constructors

Constructor	Description
UsersResource(KnockHttp knockHttp)

Method Summary

Modifier and Type	Method	Description
BulkOperation	bulkDelete(java.util.List<java.lang.String> userIds)	Identifies up to 100 users at a time.
BulkOperation	bulkIdentify(java.util.List<UserIdentity> userIdentities)	Identifies up to 100 users at a time.
void	delete(java.lang.String userId)	Delete a UserIdentity from Knock
boolean	equals(java.lang.Object o)
UserIdentity	get(java.lang.String userId)	Retrieve a user from knock
ChannelData	getChannelData(java.lang.String userId, java.lang.String channelId)	Retrieve a user's ChannelData for a particular channelId.
PreferenceSet	getDefaultPreferences(java.lang.String userId)	Retrieve a user's default preferences.
FeedCursorResult	getFeed(java.lang.String userId, java.lang.String feedId, UsersResource.FeedQueryParams feedQueryParams)	Returns a cursor result of the users feed items for a specific feed.
KnockHttp	getKnockHttp()
CursorResult<KnockMessage>	getMessages(java.lang.String userId, MessagesResource.QueryParams queryParams)	Retrieve a CursorResult of messages for a specific User.
java.util.List<PreferenceSet>	getPreferences(java.lang.String userId)	Retrieve a user's PreferenceSet
PreferenceSet	getPreferencesById(java.lang.String userId, java.lang.String preferenceId)	Retrieve a user's specific preference set by ID.
int	hashCode()
UserIdentity	identify(UserIdentity identity)	Identify a user to Knock, using the identity provided by the UserIdentity object.
UserIdentity	identify(java.lang.String userId, UserIdentity identity)	Identify a user to Knock
UserIdentity	merge(java.lang.String userId, java.lang.String fromUserId)	Merges the two users together, merging the user specified in the from_user_id into the userId
java.util.Optional<UserIdentity>	oGet(java.lang.String userId)	Retrieve an optional UserIdentity from Knock.
ChannelData	setChannelData(java.lang.String userId, java.lang.String channelId, java.util.Map<java.lang.String,java.lang.Object> data)	Set ChannelData for a specific userId, and channelId.
PreferenceSet	setPreferences(java.lang.String userId, PreferenceSetRequest preferenceSetRequest)	Set a user's specific preference set.
java.lang.String	toString()
void	unsetChannelData(java.lang.String userId, java.lang.String channelId)	Remove all channel data for the specified userId, and channelId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UsersResource

public UsersResource(KnockHttp knockHttp)

Method Detail

identify

public UserIdentity identify(UserIdentity identity)

Identify a user to Knock, using the identity provided by the UserIdentity object.

Parameters:

identity -

Returns:

user identity

Throws:

KnockClientResourceException

identify

public UserIdentity identify(java.lang.String userId,
                             UserIdentity identity)

Identify a user to Knock

Parameters:

userId -

identity -

Returns:

user identity

Throws:

KnockClientResourceException

bulkIdentify

public BulkOperation bulkIdentify(java.util.List<UserIdentity> userIdentities)

Identifies up to 100 users at a time. Returns a BulkOperation that executes the job asynchronously. Progress can be tracked via the BulkOperation API.

Parameters:

userIdentities -

Returns:

a bulk operation

get

public UserIdentity get(java.lang.String userId)

Retrieve a user from knock

Parameters:

userId -

Returns:

user identity

Throws:

KnockClientResourceException

oGet

public java.util.Optional<UserIdentity> oGet(java.lang.String userId)

Retrieve an optional UserIdentity from Knock. Catches KnockClientResourceExceptions and will return an empty Optional.

Parameters:

userId -

Returns:

an Optional of user identity

Throws:

KnockClientResourceException

merge

public UserIdentity merge(java.lang.String userId,
                          java.lang.String fromUserId)

Merges the two users together, merging the user specified in the from_user_id into the userId

Parameters:

userId -

Throws:

KnockClientResourceException

delete

public void delete(java.lang.String userId)

Delete a UserIdentity from Knock

Parameters:

userId -

Throws:

KnockClientResourceException

bulkDelete

public BulkOperation bulkDelete(java.util.List<java.lang.String> userIds)

Identifies up to 100 users at a time. Returns a BulkOperation that executes the job asynchronously. Progress can be tracked via the BulkOperation API.

Parameters:

userIds -

Returns:

a bulk operation

Throws:

KnockClientResourceException

getMessages

public CursorResult<KnockMessage> getMessages(java.lang.String userId,
                                              MessagesResource.QueryParams queryParams)

Retrieve a CursorResult of messages for a specific User.

Parameters:

userId -

queryParams -

Returns:

getChannelData

public ChannelData getChannelData(java.lang.String userId,
                                  java.lang.String channelId)

Retrieve a user's ChannelData for a particular channelId.

Parameters:

userId -

channelId -

Returns:

channel data

Throws:

KnockClientResourceException

unsetChannelData

public void unsetChannelData(java.lang.String userId,
                             java.lang.String channelId)

Remove all channel data for the specified userId, and channelId

Parameters:

userId -

channelId -

Throws:

KnockClientResourceException

setChannelData

public ChannelData setChannelData(java.lang.String userId,
                                  java.lang.String channelId,
                                  java.util.Map<java.lang.String,java.lang.Object> data)

Set ChannelData for a specific userId, and channelId.

Parameters:

userId -

channelId -

data -

Returns:

channel data

Throws:

KnockClientResourceException

getPreferences

public java.util.List<PreferenceSet> getPreferences(java.lang.String userId)

Retrieve a user's PreferenceSet

Parameters:

userId -

Returns:

a list of preference sets.

Throws:

KnockClientResourceException

getDefaultPreferences

public PreferenceSet getDefaultPreferences(java.lang.String userId)

Retrieve a user's default preferences.

Parameters:

userId -

Returns:

a preference set

Throws:

KnockClientResourceException

getPreferencesById

public PreferenceSet getPreferencesById(java.lang.String userId,
                                        java.lang.String preferenceId)

Retrieve a user's specific preference set by ID.

Parameters:

userId -

preferenceId -

Returns:

a preference set

Throws:

KnockClientResourceException

setPreferences

public PreferenceSet setPreferences(java.lang.String userId,
                                    PreferenceSetRequest preferenceSetRequest)

Set a user's specific preference set. If preferenceSetRequest.id is not specified, it will be set to "default

Parameters:

userId -

preferenceSetRequest -

Returns:

the updated preference set

Throws:

KnockClientResourceException

getFeed

public FeedCursorResult getFeed(java.lang.String userId,
                                java.lang.String feedId,
                                UsersResource.FeedQueryParams feedQueryParams)

Returns a cursor result of the users feed items for a specific feed.

Parameters:

userId -

feedId -

feedQueryParams -

Returns:

a feed item cursor

Throws:

KnockClientResourceException

getKnockHttp

public KnockHttp getKnockHttp()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object