Package de.jcm.discordgamesdk

Class RelationshipManager

java.lang.Object

de.jcm.discordgamesdk.RelationshipManager

public class RelationshipManager
extends Object

Manager to fetch information about the current user's relationships with other users.

See Also:

• https://discordapp.com/developers/docs/game-sdk/relationships

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<Relationship>	FRIEND_FILTER	Matches friends (RelationshipType.FRIEND):
static final Predicate<Relationship>	NO_FILTER	Matches any relationship.
static final Predicate<Relationship>	OFFLINE_FILTER	Matches offline (not idle or DND) users (OnlineStatus.OFFLINE).
static final Predicate<Relationship>	ONLINE_FILTER	Matches online (not idle or DND) users (OnlineStatus.ONLINE).
static final Predicate<Relationship>	SPECIAL_FILTER	Matches users that are doing something special (playing, watching, listening, having a custom status, etc.).

Method Summary

Modifier and Type	Method	Description
List<Relationship>	asList()	Fetches a filtered list of relationships.
int	count()	Fetches the count of relationships that match your filter.
void	filter(Predicate<Relationship> filter)	Filters the user's relationship by a certain Predicate.
Relationship	getAt(int index)	Fetches a relationships at a certain position in the filtered list.
Relationship	getWith(long userId)	Fetches the relationship with another user.

Methods inherited from class java.lang.Object

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

Field Details

NO_FILTER

public static final Predicate<Relationship> NO_FILTER

Matches any relationship.

FRIEND_FILTER

public static final Predicate<Relationship> FRIEND_FILTER

Matches friends (RelationshipType.FRIEND):

ONLINE_FILTER

public static final Predicate<Relationship> ONLINE_FILTER

Matches online (not idle or DND) users (OnlineStatus.ONLINE).

OFFLINE_FILTER

public static final Predicate<Relationship> OFFLINE_FILTER

Matches offline (not idle or DND) users (OnlineStatus.OFFLINE).

SPECIAL_FILTER

public static final Predicate<Relationship> SPECIAL_FILTER

Matches users that are doing something special (playing, watching, listening, having a custom status, etc.).

Method Details

getWith

public Relationship getWith(long userId)

Fetches the relationship with another user.

Parameters:

userId - ID to identifier the other user

Returns:

The Relationship between the users

Throws:

GameSDKException - if something went wrong fetching the relationship information

See Also:

• https://discordapp.com/developers/docs/game-sdk/relationships#get

filter

public void filter(Predicate<Relationship> filter)

Filters the user's relationship by a certain Predicate.

Parameters:

filter - Predicate to filter the relationships with.

See Also:

• https://discordapp.com/developers/docs/game-sdk/relationships#filter

count

public int count()

Fetches the count of relationships that match your filter.

Only works if you called filter(Predicate) first, returns Result.NOT_FOUND otherwise.

Returns:

The count.

Throws:

GameSDKException - if something went wrong fetching the relationship count

See Also:

• getAt(int)
• https://discordapp.com/developers/docs/game-sdk/relationships#count

getAt

public Relationship getAt(int index)

Fetches a relationships at a certain position in the filtered list.

Only works if you called filter(Predicate) first, returns Result.NOT_FILTERED otherwise.

Parameters:

index - The index of the relationships

Returns:

The relationships

Throws:

GameSDKException - if something went wrong fetching the relationship

See Also:

• count()
• https://discordapp.com/developers/docs/game-sdk/relationships#getat

asList

public List<Relationship> asList()

Fetches a filtered list of relationships.

Only works if you called filter(Predicate) first, throws a GameSDKException with Result.NOT_FOUND otherwise.

Returns:

A list of relationships

Throws:

GameSDKException - if something went wrong fetching the relationship list