From fc198504cd7afb8ff0893911fc954553d9f224cc Mon Sep 17 00:00:00 2001 From: acupofjose <9093699+acupofjose@users.noreply.github.com> Date: Wed, 22 May 2024 18:55:01 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20supabase?= =?UTF-8?q?-community/realtime-csharp@85249b0df779e0c2b3a6d3457f3aa4c2f683?= =?UTF-8?q?5091=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...nterfaces.IRealtimePresence.EventType.html | 4 ++-- ...RealtimePresence.PresenceEventHandler.html | 4 ++-- ...Realtime.Interfaces.IRealtimePresence.html | 22 +++++++++---------- api/Supabase.Realtime.RealtimePresence-1.html | 10 ++++----- index.json | 4 ++-- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/api/Supabase.Realtime.Interfaces.IRealtimePresence.EventType.html b/api/Supabase.Realtime.Interfaces.IRealtimePresence.EventType.html index 8337aa7..2bfefa1 100644 --- a/api/Supabase.Realtime.Interfaces.IRealtimePresence.EventType.html +++ b/api/Supabase.Realtime.Interfaces.IRealtimePresence.EventType.html @@ -90,7 +90,7 @@
Table of Contents

-Enum IRealtimePresence.EventType +Enum IRealtimePresence.EventType

@@ -133,7 +133,7 @@

Fields
- Edit this page + Edit this page
diff --git a/api/Supabase.Realtime.Interfaces.IRealtimePresence.PresenceEventHandler.html b/api/Supabase.Realtime.Interfaces.IRealtimePresence.PresenceEventHandler.html index 629971d..5c44567 100644 --- a/api/Supabase.Realtime.Interfaces.IRealtimePresence.PresenceEventHandler.html +++ b/api/Supabase.Realtime.Interfaces.IRealtimePresence.PresenceEventHandler.html @@ -89,7 +89,7 @@

Table of Contents

-Delegate IRealtimePresence.PresenceEventHandler +Delegate IRealtimePresence.PresenceEventHandler

@@ -128,7 +128,7 @@

Parameters

- Edit this page + Edit this page
diff --git a/api/Supabase.Realtime.Interfaces.IRealtimePresence.html b/api/Supabase.Realtime.Interfaces.IRealtimePresence.html index d4ea213..0169b05 100644 --- a/api/Supabase.Realtime.Interfaces.IRealtimePresence.html +++ b/api/Supabase.Realtime.Interfaces.IRealtimePresence.html @@ -89,7 +89,7 @@
Table of Contents

-Interface IRealtimePresence +Interface IRealtimePresence

@@ -125,7 +125,7 @@

Methods

AddPresenceEventHandler(EventType, PresenceEventHandler) - +

Add a presence event handler

@@ -159,7 +159,7 @@

Parameters

ClearPresenceEventHandlers(EventType?) - +

Clear presence events.

@@ -191,7 +191,7 @@

Parameters

RemovePresenceEventHandlers(EventType, PresenceEventHandler) - +

Remove a presence event handler

@@ -225,7 +225,7 @@

Parameters

Track(object?, int) - +

Send an arbitrary payload as a presence event, MUST be called once to register this client as an active presence.

@@ -233,7 +233,7 @@

- 
Task Track(object? payload, int timeoutMs = 10000)
+ 
Task<Push> Track(object? payload, int timeoutMs = 10000)

Parameters

@@ -246,7 +246,7 @@

Parameters

Returns

-
Task
+
Task<Push>
@@ -264,7 +264,7 @@

Returns

Untrack() - +

Untracks a client

@@ -272,13 +272,13 @@

- 
Task Untrack()
+ 
Task<Push> Untrack()

Returns

-
Task
+
Task<Push>
@@ -296,7 +296,7 @@

Returns

- Edit this page + Edit this page
diff --git a/api/Supabase.Realtime.RealtimePresence-1.html b/api/Supabase.Realtime.RealtimePresence-1.html index 0b55154..d8c16e0 100644 --- a/api/Supabase.Realtime.RealtimePresence-1.html +++ b/api/Supabase.Realtime.RealtimePresence-1.html @@ -388,7 +388,7 @@

- 
public Task Track(object? payload, int timeoutMs = 10000)
+ 
public Task<Push> Track(object? payload, int timeoutMs = 10000)

Parameters

@@ -401,7 +401,7 @@

Parameters

Returns

-
Task
+
Task<Push>
@@ -490,7 +490,7 @@

Parameters

Untrack() - +

Untracks an event.

@@ -498,13 +498,13 @@

- 
public Task Untrack()
+ 
public Task<Push> Untrack()

Returns

-
Task
+
Task<Push>
diff --git a/index.json b/index.json index 6185920..b864c46 100644 --- a/index.json +++ b/index.json @@ -167,7 +167,7 @@ "api/Supabase.Realtime.Interfaces.IRealtimePresence.html": { "href": "api/Supabase.Realtime.Interfaces.IRealtimePresence.html", "title": "Interface IRealtimePresence | realtime-csharp", - "keywords": "Interface IRealtimePresence Namespace Supabase.Realtime.Interfaces Assembly Supabase.Realtime.dll Contract representing a Realtime Presence class public interface IRealtimePresence Methods AddPresenceEventHandler(EventType, PresenceEventHandler) Add a presence event handler void AddPresenceEventHandler(IRealtimePresence.EventType eventType, IRealtimePresence.PresenceEventHandler handler) Parameters eventType IRealtimePresence.EventType handler IRealtimePresence.PresenceEventHandler ClearPresenceEventHandlers(EventType?) Clear presence events. void ClearPresenceEventHandlers(IRealtimePresence.EventType? eventType = null) Parameters eventType IRealtimePresence.EventType? RemovePresenceEventHandlers(EventType, PresenceEventHandler) Remove a presence event handler void RemovePresenceEventHandlers(IRealtimePresence.EventType eventType, IRealtimePresence.PresenceEventHandler handler) Parameters eventType IRealtimePresence.EventType handler IRealtimePresence.PresenceEventHandler Track(object?, int) Send an arbitrary payload as a presence event, MUST be called once to register this client as an active presence. Task Track(object? payload, int timeoutMs = 10000) Parameters payload object timeoutMs int Returns Task Untrack() Untracks a client Task Untrack() Returns Task" + "keywords": "Interface IRealtimePresence Namespace Supabase.Realtime.Interfaces Assembly Supabase.Realtime.dll Contract representing a Realtime Presence class public interface IRealtimePresence Methods AddPresenceEventHandler(EventType, PresenceEventHandler) Add a presence event handler void AddPresenceEventHandler(IRealtimePresence.EventType eventType, IRealtimePresence.PresenceEventHandler handler) Parameters eventType IRealtimePresence.EventType handler IRealtimePresence.PresenceEventHandler ClearPresenceEventHandlers(EventType?) Clear presence events. void ClearPresenceEventHandlers(IRealtimePresence.EventType? eventType = null) Parameters eventType IRealtimePresence.EventType? RemovePresenceEventHandlers(EventType, PresenceEventHandler) Remove a presence event handler void RemovePresenceEventHandlers(IRealtimePresence.EventType eventType, IRealtimePresence.PresenceEventHandler handler) Parameters eventType IRealtimePresence.EventType handler IRealtimePresence.PresenceEventHandler Track(object?, int) Send an arbitrary payload as a presence event, MUST be called once to register this client as an active presence. Task Track(object? payload, int timeoutMs = 10000) Parameters payload object timeoutMs int Returns Task Untrack() Untracks a client Task Untrack() Returns Task" }, "api/Supabase.Realtime.Interfaces.IRealtimePush-2.MessageEventHandler.html": { "href": "api/Supabase.Realtime.Interfaces.IRealtimePush-2.MessageEventHandler.html", @@ -317,7 +317,7 @@ "api/Supabase.Realtime.RealtimePresence-1.html": { "href": "api/Supabase.Realtime.RealtimePresence-1.html", "title": "Class RealtimePresence | realtime-csharp", - "keywords": "Class RealtimePresence Namespace Supabase.Realtime Assembly Supabase.Realtime.dll Represents a realtime presence client. When a client subscribes to a channel, it will immediately receive the channel's latest state in a single message. Clients are free to come-and-go as they please, and as long as they are all subscribed to the same channel then they will all have the same Presence state as each other. If a client is suddenly disconnected (for example, they go offline), their state will be automatically removed from the shared state. public class RealtimePresence : IRealtimePresence where TPresenceModel : BasePresence Type Parameters TPresenceModel A model representing expected payload. Inheritance object RealtimePresence Implements IRealtimePresence Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors RealtimePresence(RealtimeChannel, PresenceOptions, JsonSerializerSettings) Initializes a realtime presence helper class. public RealtimePresence(RealtimeChannel channel, PresenceOptions options, JsonSerializerSettings serializerSettings) Parameters channel RealtimeChannel options PresenceOptions serializerSettings JsonSerializerSettings Properties CurrentState The Current State of this Presence instance. public Dictionary> CurrentState { get; } Property Value Dictionary> LastState The Last State of this Presence instance. public Dictionary> LastState { get; } Property Value Dictionary> Methods AddPresenceEventHandler(EventType, PresenceEventHandler) Add presence event handler for a given event type. public void AddPresenceEventHandler(IRealtimePresence.EventType eventType, IRealtimePresence.PresenceEventHandler handler) Parameters eventType IRealtimePresence.EventType handler IRealtimePresence.PresenceEventHandler ClearPresenceEventHandlers(EventType?) Clears all event handlers for a given type (if specified) or clears all handlers. public void ClearPresenceEventHandlers(IRealtimePresence.EventType? eventType = null) Parameters eventType IRealtimePresence.EventType? RemovePresenceEventHandlers(EventType, PresenceEventHandler) Remove an event handler public void RemovePresenceEventHandlers(IRealtimePresence.EventType eventType, IRealtimePresence.PresenceEventHandler handler) Parameters eventType IRealtimePresence.EventType handler IRealtimePresence.PresenceEventHandler Track(object?, int) \"Tracks\" an event, used with Supabase.Realtime.Presence. public Task Track(object? payload, int timeoutMs = 10000) Parameters payload object timeoutMs int Returns Task TriggerDiff(SocketResponse) Triggers a diff comparison and emits events accordingly. public void TriggerDiff(SocketResponse response) Parameters response SocketResponse Exceptions ArgumentException TriggerSync(SocketResponse) Called in two cases: - By RealtimeChannel when it receives a presence_state initializing message. - By RealtimeChannel When a diff has been received and a new response is saved. public void TriggerSync(SocketResponse response) Parameters response SocketResponse Untrack() Untracks an event. public Task Untrack() Returns Task" + "keywords": "Class RealtimePresence Namespace Supabase.Realtime Assembly Supabase.Realtime.dll Represents a realtime presence client. When a client subscribes to a channel, it will immediately receive the channel's latest state in a single message. Clients are free to come-and-go as they please, and as long as they are all subscribed to the same channel then they will all have the same Presence state as each other. If a client is suddenly disconnected (for example, they go offline), their state will be automatically removed from the shared state. public class RealtimePresence : IRealtimePresence where TPresenceModel : BasePresence Type Parameters TPresenceModel A model representing expected payload. Inheritance object RealtimePresence Implements IRealtimePresence Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors RealtimePresence(RealtimeChannel, PresenceOptions, JsonSerializerSettings) Initializes a realtime presence helper class. public RealtimePresence(RealtimeChannel channel, PresenceOptions options, JsonSerializerSettings serializerSettings) Parameters channel RealtimeChannel options PresenceOptions serializerSettings JsonSerializerSettings Properties CurrentState The Current State of this Presence instance. public Dictionary> CurrentState { get; } Property Value Dictionary> LastState The Last State of this Presence instance. public Dictionary> LastState { get; } Property Value Dictionary> Methods AddPresenceEventHandler(EventType, PresenceEventHandler) Add presence event handler for a given event type. public void AddPresenceEventHandler(IRealtimePresence.EventType eventType, IRealtimePresence.PresenceEventHandler handler) Parameters eventType IRealtimePresence.EventType handler IRealtimePresence.PresenceEventHandler ClearPresenceEventHandlers(EventType?) Clears all event handlers for a given type (if specified) or clears all handlers. public void ClearPresenceEventHandlers(IRealtimePresence.EventType? eventType = null) Parameters eventType IRealtimePresence.EventType? RemovePresenceEventHandlers(EventType, PresenceEventHandler) Remove an event handler public void RemovePresenceEventHandlers(IRealtimePresence.EventType eventType, IRealtimePresence.PresenceEventHandler handler) Parameters eventType IRealtimePresence.EventType handler IRealtimePresence.PresenceEventHandler Track(object?, int) \"Tracks\" an event, used with Supabase.Realtime.Presence. public Task Track(object? payload, int timeoutMs = 10000) Parameters payload object timeoutMs int Returns Task TriggerDiff(SocketResponse) Triggers a diff comparison and emits events accordingly. public void TriggerDiff(SocketResponse response) Parameters response SocketResponse Exceptions ArgumentException TriggerSync(SocketResponse) Called in two cases: - By RealtimeChannel when it receives a presence_state initializing message. - By RealtimeChannel When a diff has been received and a new response is saved. public void TriggerSync(SocketResponse response) Parameters response SocketResponse Untrack() Untracks an event. public Task Untrack() Returns Task" }, "api/Supabase.Realtime.RealtimeSocket.html": { "href": "api/Supabase.Realtime.RealtimeSocket.html",