Skip to content

Add user presence code examples #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sierpinskid merged 1 commit into from
Mar 28, 2024
Merged

Add user presence code examples #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Assets/Plugins/StreamChat/Core/StatefulModels/IStreamUser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public interface IStreamUser : IStreamStatefulModel

/// <summary>
/// Invisible user will appear as offline to other users
/// You can change user visibility with <see cref="ChangeVisibilityAsync"/>
/// You can change user visibility with <see cref="MarkInvisibleAsync"/> & <see cref="MarkVisibleAsync"/>
/// </summary>
/// <remarks>https://getstream.io/chat/docs/unity/presence_format/?language=unity</remarks>
bool Invisible { get; }
Expand Down
208 changes: 103 additions & 105 deletions Assets/Plugins/StreamChat/Samples/MessagesCodeSamples.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,39 +17,39 @@ internal sealed class MessagesCodeSamples
/// </summary>
public async Task Overview()
{
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");
var message = await channel.SendNewMessageAsync("Hello world!");
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");
var message = await channel.SendNewMessageAsync("Hello world!");
}

/// <summary>
/// https://getstream.io/chat/docs/unity/send_message/?language=unity#complex-example
/// </summary>
public async Task ComplexExample()
{
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, "my-channel-id");
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, "my-channel-id");

IStreamUser someUser = null;
IStreamUser someUser = null;

// Send simple message with text only
var message3 = await channel.SendNewMessageAsync("Hello");
var message3 = await channel.SendNewMessageAsync("Hello");

// Send simple message with text only
var message2 = await channel.SendNewMessageAsync("Let's start a thread!");
var message2 = await channel.SendNewMessageAsync("Let's start a thread!");

var message = await channel.SendNewMessageAsync(new StreamSendMessageRequest
{
MentionedUsers = new List<IStreamUser> { someUser }, // Mention a user
ParentId = message2.Id, // Write in thread
PinExpires = new DateTimeOffset(DateTime.Now).AddDays(7), // Pin for 7 days
Pinned = true,
QuotedMessage = message3,
ShowInChannel = true,
Text = "Hello",
CustomData = new StreamCustomDataRequest
{
{ "my_lucky_numbers", new List<int> { 7, 13, 81 } }
}
});
var message = await channel.SendNewMessageAsync(new StreamSendMessageRequest
{
MentionedUsers = new List<IStreamUser> { someUser }, // Mention a user
ParentId = message2.Id, // Write in thread
PinExpires = new DateTimeOffset(DateTime.Now).AddDays(7), // Pin for 7 days
Pinned = true,
QuotedMessage = message3,
ShowInChannel = true,
Text = "Hello",
CustomData = new StreamCustomDataRequest
{
{ "my_lucky_numbers", new List<int> { 7, 13, 81 } }
}
});
}

/// <summary>
Expand All @@ -65,18 +65,18 @@ public async Task GetMessageById()
/// </summary>
public async Task UpdateAMessage()
{
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");
var message = await channel.SendNewMessageAsync("Hello world!");
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");
var message = await channel.SendNewMessageAsync("Hello world!");

// Edit message text and some custom data
await message.UpdateAsync(new StreamUpdateMessageRequest
{
Text = "Hi everyone!",
CustomData = new StreamCustomDataRequest
{
{"tags", new [] {"Funny", "Unique"}}
}
});
await message.UpdateAsync(new StreamUpdateMessageRequest
{
Text = "Hi everyone!",
CustomData = new StreamCustomDataRequest
{
{ "tags", new[] { "Funny", "Unique" } }
}
});
}

/// <summary>
Expand All @@ -92,14 +92,14 @@ public async Task PartialUpdate()
/// </summary>
public async Task DeleteAMessage()
{
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");
var message = await channel.SendNewMessageAsync("Hello world!");
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");
var message = await channel.SendNewMessageAsync("Hello world!");

// Soft delete
await message.SoftDeleteAsync();
await message.SoftDeleteAsync();

// Hard delete
await message.HardDeleteAsync();
await message.HardDeleteAsync();
}

/// <summary>
Expand All @@ -118,24 +118,23 @@ public async Task UploadFileOrImage()
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");

// Get file byte array however you want e.g. Addressables.LoadAsset, Resources.Load, etc.
var sampleFile = File.ReadAllBytes("path/to/file");
var fileUploadResponse = await channel.UploadFileAsync(sampleFile, "my-file-name");
var fileWebUrl = fileUploadResponse.FileUrl;
var sampleFile = File.ReadAllBytes("path/to/file");
var fileUploadResponse = await channel.UploadFileAsync(sampleFile, "my-file-name");
var fileWebUrl = fileUploadResponse.FileUrl;

// Get image byte array however you want e.g. Addressables.LoadAsset, Resources.Load, etc.
var sampleImage = File.ReadAllBytes("path/to/file");
var imageUploadResponse = await channel.UploadImageAsync(sampleFile, "my-image-name");
var imageWebUrl = imageUploadResponse.FileUrl;

var sampleImage = File.ReadAllBytes("path/to/file");
var imageUploadResponse = await channel.UploadImageAsync(sampleFile, "my-image-name");
var imageWebUrl = imageUploadResponse.FileUrl;
}

/// <summary>
/// https://getstream.io/chat/docs/unity/file_uploads/?language=unity#deleting-files-and-images
/// </summary>
public async Task DeleteFileOrImage()
{
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");
await channel.DeleteFileOrImageAsync("file-url");
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");
await channel.DeleteFileOrImageAsync("file-url");
}

/// <summary>
Expand All @@ -146,19 +145,19 @@ public async Task UsingYourOwnCdn()
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");

//Implement your own CDN upload and obtain the file URL
var fileUrl = "file-url-to-your-cdn";
var fileUrl = "file-url-to-your-cdn";

await channel.SendNewMessageAsync(new StreamSendMessageRequest
{
Text = "Message with file attachment",
Attachments = new List<StreamAttachmentRequest>
{
new StreamAttachmentRequest
{
AssetUrl = fileUrl,
}
}
});
await channel.SendNewMessageAsync(new StreamSendMessageRequest
{
Text = "Message with file attachment",
Attachments = new List<StreamAttachmentRequest>
{
new StreamAttachmentRequest
{
AssetUrl = fileUrl,
}
}
});

await Task.CompletedTask;
}
Expand All @@ -172,16 +171,16 @@ public async Task ReactionOverview()
var message = await channel.SendNewMessageAsync("Hello world!");

// Send simple reaction with a score of 1
await message.SendReactionAsync("like");
await message.SendReactionAsync("like");

// Send reaction with a custom score value
await message.SendReactionAsync("clap", 10);
await message.SendReactionAsync("clap", 10);

// Send reaction with a custom score value
await message.SendReactionAsync("clap", 10);
await message.SendReactionAsync("clap", 10);

// Send reaction and replace all previous reactions (if any) from this user
await message.SendReactionAsync("love", enforceUnique: true);
await message.SendReactionAsync("love", enforceUnique: true);
}

/// <summary>
Expand All @@ -192,7 +191,7 @@ public async Task RemoveReaction()
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");
var message = await channel.SendNewMessageAsync("Hello world!");

await message.DeleteReactionAsync("like");
await message.DeleteReactionAsync("like");
}

/// <summary>
Expand All @@ -214,7 +213,7 @@ public async Task CumulativeReactions()
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, channelId: "my-channel-id");
var message = await channel.SendNewMessageAsync("Hello world!");

await message.SendReactionAsync("clap", score: 3);
await message.SendReactionAsync("clap", score: 3);
}

/// <summary>
Expand All @@ -228,14 +227,14 @@ public async Task ThreadsAndReplies()
var message3 = await channel.SendNewMessageAsync("Hello");

// Send simple message with text only
var parentMessage = await channel.SendNewMessageAsync("Let's start a thread!");
var parentMessage = await channel.SendNewMessageAsync("Let's start a thread!");

var messageInThread = await channel.SendNewMessageAsync(new StreamSendMessageRequest
{
ParentId = parentMessage.Id, // Write in thread
ShowInChannel = false, // Optionally send to both thread and the main channel like in Slack
Text = "Hello",
});
var messageInThread = await channel.SendNewMessageAsync(new StreamSendMessageRequest
{
ParentId = parentMessage.Id, // Write in thread
ShowInChannel = false, // Optionally send to both thread and the main channel like in Slack
Text = "Hello",
});
}

/// <summary>
Expand All @@ -259,11 +258,11 @@ public async Task QuoteMessage()
// Send simple message with text only
var quotedMessage = await channel.SendNewMessageAsync("Let's start a thread!");

var messageWithQuote = await channel.SendNewMessageAsync(new StreamSendMessageRequest
{
QuotedMessage = quotedMessage,
Text = "Hello",
});
var messageWithQuote = await channel.SendNewMessageAsync(new StreamSendMessageRequest
{
QuotedMessage = quotedMessage,
Text = "Hello",
});
}

/// <summary>
Expand All @@ -282,46 +281,45 @@ public async Task SilentMessages()
var channel = await Client.GetOrCreateChannelWithIdAsync(ChannelType.Messaging, "my-channel-id");

// This message will not trigger events for channel members
var silentMessage = await channel.SendNewMessageAsync(new StreamSendMessageRequest
{
Text = "System message",
Silent = true
});
var silentMessage = await channel.SendNewMessageAsync(new StreamSendMessageRequest
{
Text = "System message",
Silent = true
});
}

/// <summary>
/// https://getstream.io/chat/docs/unity/search/?language=unity
/// </summary>
public async Task Search()
{

// Access to low-level client is left for backward compatibility. Soon simplified syntax for searching will be implemented
var searchResponse = await Client.LowLevelClient.MessageApi.SearchMessagesAsync(new SearchRequest
{
//Filter is required for search
FilterConditions = new Dictionary<string, object>
{
{
//Get channels that local user is a member of
"members", new Dictionary<string, object>
var searchResponse = await Client.LowLevelClient.MessageApi.SearchMessagesAsync(new SearchRequest
{
//Filter is required for search
FilterConditions = new Dictionary<string, object>
{
{
//Get channels that local user is a member of
"members", new Dictionary<string, object>
{
{ "$in", new[] { "John" } }
}
}
},

//search phrase
Query = "supercalifragilisticexpialidocious"
});

foreach (var searchResult in searchResponse.Results)
{
{ "$in", new[] { "John" } }
Debug.Log(searchResult.Message.Id); //Message ID
Debug.Log(searchResult.Message.Text); //Message text
Debug.Log(searchResult.Message.User); //Message author info
Debug.Log(searchResult.Message.Channel); //Channel info
}
}
},

//search phrase
Query = "supercalifragilisticexpialidocious"
});

foreach (var searchResult in searchResponse.Results)
{
Debug.Log(searchResult.Message.Id); //Message ID
Debug.Log(searchResult.Message.Text); //Message text
Debug.Log(searchResult.Message.User); //Message author info
Debug.Log(searchResult.Message.Channel); //Channel info
}
}

/// <summary>
/// https://getstream.io/chat/docs/unity/search/?language=unity#pagination
Expand All @@ -339,13 +337,13 @@ public async Task PinAndUnpinMessage()
IStreamMessage message = null;

// Pin until unpinned
await message.PinAsync();
await message.PinAsync();

// Pin for 7 days
await message.PinAsync(new DateTime().AddDays(7));
await message.PinAsync(new DateTime().AddDays(7));

// Unpin previously pinned message
await message.UnpinAsync();
await message.UnpinAsync();
}

/// <summary>
Expand Down
Loading