Relationships

This manager helps you access the relationships your players have made on Discord. Unfortunately, it won't help them make relationships IRL. They're on their own for that. It lets you:

• Access a user's relationships
• Filter those relationships based on a given criteria
• Build a user's friends list

Relationships on Discord change often; people start and stop playing games, go online, offline, invisible, or otherwise change state. Therefore, there are some important factors to remember when working with this manager. When you are first getting a list of a user's relationships, before you can Filter(), you need to wait for the OnRefresh callback to fire. This is your indicator that Discord has successfully taken a snapshot of the state of all your relationships at a given moment. Now that you have this snapshot, you can Filter() it to build the list that you want, and then iterate over that list to do whatever your game needs to do. Use this to build your initial social graph for a user.

As relationships change, the OnRelationshipUpdate event will fire. You can use this to update the user's social graph, changing the status of the other Discord users that you chose to filter, e.g. someone is now online, or now playing the game, or no longer playing.

An example of how to do this properly is at the end of this documentation page.

Filters a user's relationship list by a boolean condition.

Returns void.

A function that takes a Relationship parameter.

cs
relationshipsManager.Filter(relationship =>
{
  return relationship.Presence.Status == Discord.Status.Online;
});

Get the relationship between the current user and a given user by id.

Returns a Relationship.

cs
var friend = relationshipsManager.Get(53908232506183680);
Console.WriteLine("This is my friend, {0}", friend.User.Username);

Get the relationship at a given index when iterating over a list of relationships.

Returns a Relationship.

cs
for (int i = 0; i < relationshipsManager.Count(); i++)
{
  var r = relationshipsManager.GetAt(i);
  Console.WriteLine("This person is {0}", r.User.Username);
}

Get the number of relationships that match your Filter().

Returns an Int32.

None

cs
for (int i = 0; i < relationshipsManager.Count(); i++)
{
  var r = relationshipsManager.At(i);
  Console.WriteLine("This person is {0}", r.User.Username);
}

Fires at initialization when Discord has cached a snapshot of the current status of all your relationships. Wait for this to fire before calling Filter within its callback.

None

Fires when a relationship in the filtered list changes, like an updated presence or user attribute.

cs
OnRelationshipUpdate += (ref Discord.Relationship relationship) =>
{
  Console.WriteLine("Who changed? {0}", relationship.User.Id);
};

cs
var discord = new Discord.Discord(clientId, Discord.CreateFlags.Default);
var relationshipManager = discord.GetRelationshipManager();

// Assign this handle right away to get the initial relationships update.
// This callback will only be fired when the whole list is initially loaded or was reset

// Wait for OnRefresh to fire to access a stable list
// Filter a user's relationship list to be just friends
// Use this list as your base
relationshipManager.OnRefresh += () =>
{
  relationshipManager.Filter((relationship) =>
  {
    return relationship.Type == Discord.RelationshipType.Friend;
  });

  // Loop over all friends a user has.
  Console.WriteLine("relationships updated: {0}", relationshipManager.Count());

  for (var i = 0; i < relationshipManager.Count(); i++)
  {
      // Get an individual relationship from the list
      var r = relationshipManager.GetAt((uint)i);
      Console.WriteLine("relationships: {0} {1}", r.Type, r.User.Username);
      // Save r off to a list of user's relationships
  }
}

relationshipManager.OnRelationshipUpdate += (ref Discord.Relationship relationship) =>
{
  Console.WriteLine("User is {0}", relationship.User.Username);
  // Update the matching user in your previously created list
}

cs
var discord = new Discord.Discord(clientId, Discord.CreateFlags.Default);
var relationshipManager = discord.GetRelationshipManager();
var activityManager = discord.GetActivityManager();

relationshipManager.OnRefresh += () =>
{
  relationshipManager.Filter((relationship) =>
  {
    // Filter for users who are playing the same game as the current user
    // Is their activity application id the same as my client id?
    return relationship.Presence.Activity.ApplicationId == clientId;
  });

  for (var i = 0; i < relationshipManager.Count(); i++)
  {
      // Get an individual relationship from the list
      var r = relationshipManager.GetAt((uint)i);
      Console.WriteLine("relationships: {0} {1}", r.Type, r.User.Username);

      // Send them a game invite!
      activityManager.InviteUser(r.User.Id, Discord.ActivityActionType.Join, "Come play with me!", (result) =>
      {
        Console.WriteLine("Invited user {0} to play with you", r.User.Username);
      });
  };
}