SDR-RPC/SDR-RPC/DiscordAPI/DiscordRpcClient.cs at master · enderice2/SDR-RPC

915 lines (767 loc) · 40.7 KB
﻿using DiscordRPC.Events;
using DiscordRPC.Exceptions;
using DiscordRPC.IO;
using DiscordRPC.Logging;
using DiscordRPC.Message;
using DiscordRPC.Registry;
using DiscordRPC.RPC;
using DiscordRPC.RPC.Commands;
using System;
namespace DiscordRPC
    /// <summary>
    /// A Discord RPC Client which is used to send Rich Presence updates and receive Join / Spectate events.
    /// </summary>
    public sealed class DiscordRpcClient : IDisposable
        #region Properties
        /// <summary>
        /// Gets a value indicating if the client has registered a URI Scheme. If this is false, Join / Spectate events will fail.
        /// <para>To register a URI Scheme, call <see cref="RegisterUriScheme(string, string)"/>.</para>
        /// </summary>
        public bool HasRegisteredUriScheme { get; private set; }
        /// <summary>
        /// Gets the Application ID of the RPC Client.
        /// </summary>
        public string ApplicationID { get; private set; }
        /// <summary>
        /// Gets the Steam ID of the RPC Client. This value can be null if none was supplied.
        /// </summary>
        public string SteamID { get; private set; }
        /// <summary>
        /// Gets the ID of the process used to run the RPC Client. Discord tracks this process ID and waits for its termination. Defaults to the current application process ID.
        /// </summary>
        public int ProcessID { get; private set; }
        /// <summary>
        /// The maximum size of the message queue received from Discord.
        /// </summary>
        public int MaxQueueSize { get; private set; }
        /// <summary>
        /// The dispose state of the client object.
        /// </summary>
        public bool IsDisposed { get; private set; }
        /// <summary>
        /// The logger used this client and its associated components. <see cref="ILogger"/> are not called safely and can come from any thread. It is upto the <see cref="ILogger"/> to account for this and apply appropriate thread safe methods.
        /// </summary>
        public ILogger Logger
            get { return _logger; }
                this._logger = value;
                if (connection != null) connection.Logger = value;
        private ILogger _logger;
        /// <summary>
        /// Indicates if the client will automatically invoke the events without <see cref="Invoke"/> having to be called.
        /// </summary>
        public bool AutoEvents { get; private set; }
        /// <summary>
        /// Skips sending presences that are identical to the current one.
        /// </summary>
        public bool SkipIdenticalPresence { get; set; }
        #endregion Properties
        /// <summary>
        /// The pipe the discord client is on, ranging from 0 to 9. Use -1 to scan through all pipes.
        /// <para>This property can be used for testing multiple clients. For example, if a Discord Client was on pipe 0, the Discord Canary is most likely on pipe 1.</para>
        /// </summary>
        public int TargetPipe { get; private set; }
        private RpcConnection connection;
        /// <summary>
        /// The current presence that the client has. Gets set with <see cref="SetPresence(RichPresence)"/> and updated on <see cref="OnPresenceUpdate"/>.
        /// </summary>
        public RichPresence CurrentPresence { get; private set; }
        /// <summary>
        /// Current subscription to events. Gets set with <see cref="Subscribe(EventType)"/>, <see cref="UnsubscribeMessage"/> and updated on <see cref="OnSubscribe"/>, <see cref="OnUnsubscribe"/>.
        /// </summary>
        public EventType Subscription { get; private set; }
        /// <summary>
        /// The current discord user. This is updated with the ready event and will be null until the event is fired from the connection.
        /// </summary>
        public User CurrentUser { get; private set; }
        /// <summary>
        /// The current configuration the connection is using. Only becomes available after a ready event.
        /// </summary>
        public Configuration Configuration { get; private set; }
        /// <summary>
        /// Represents if the client has been <see cref="Initialize"/>
        /// </summary>
        public bool IsInitialized { get; private set; }
        /// <summary>
        /// Forces the connection to shutdown gracefully instead of just aborting the connection.
        /// <para>This option helps prevents ghosting in applications where the Process ID is a host and the game is executed within the host (ie: the Unity3D editor). This will tell Discord that we have no presence and we are closing the connection manually, instead of waiting for the process to terminate.</para>
        /// </summary>
        public bool ShutdownOnly
            get { return _shutdownOnly; }
                _shutdownOnly = value;
                if (connection != null) connection.ShutdownOnly = value;
        private bool _shutdownOnly = true;
        private object _sync = new object();
        #region Events
        /// <summary>
        /// Called when the discord client is ready to send and receive messages.
        /// <para>If <see cref="AutoEvents"/> is true then this event will execute on a different thread. If it is not true however, then this event is not invoked untill <see cref="Invoke"/> and will be on the calling thread.</para>
        /// </summary>
        public event OnReadyEvent OnReady;
        /// <summary>
        /// Called when connection to the Discord Client is lost. The connection will remain close and unready to accept messages until the Ready event is called again.
		/// <para>If <see cref="AutoEvents"/> is true then this event will execute on a different thread. If it is not true however, then this event is not invoked untill <see cref="Invoke"/> and will be on the calling thread.</para>
        /// </summary>
        public event OnCloseEvent OnClose;
        /// <summary>
        /// Called when a error has occured during the transmission of a message. For example, if a bad Rich Presence payload is sent, this event will be called explaining what went wrong.
        /// <para>If <see cref="AutoEvents"/> is true then this event will execute on a different thread. If it is not true however, then this event is not invoked untill <see cref="Invoke"/> and will be on the calling thread.</para>
        /// </summary>
        public event OnErrorEvent OnError;
        /// <summary>
        /// Called when the Discord Client has updated the presence.
        /// <para>If <see cref="AutoEvents"/> is true then this event will execute on a different thread. If it is not true however, then this event is not invoked untill <see cref="Invoke"/> and will be on the calling thread.</para>
        /// </summary>
        public event OnPresenceUpdateEvent OnPresenceUpdate;
        /// <summary>
        /// Called when the Discord Client has subscribed to an event.
        /// <para>If <see cref="AutoEvents"/> is true then this event will execute on a different thread. If it is not true however, then this event is not invoked untill <see cref="Invoke"/> and will be on the calling thread.</para>
        /// </summary>
        public event OnSubscribeEvent OnSubscribe;
        /// <summary>
        /// Called when the Discord Client has unsubscribed from an event.
        /// <para>If <see cref="AutoEvents"/> is true then this event will execute on a different thread. If it is not true however, then this event is not invoked untill <see cref="Invoke"/> and will be on the calling thread.</para>
        /// </summary>
        public event OnUnsubscribeEvent OnUnsubscribe;
        /// <summary>
        /// Called when the Discord Client wishes for this process to join a game.
        /// <para>If <see cref="AutoEvents"/> is true then this event will execute on a different thread. If it is not true however, then this event is not invoked untill <see cref="Invoke"/> and will be on the calling thread.</para>
        /// </summary>
        public event OnJoinEvent OnJoin;
        /// <summary>
        /// Called when the Discord Client wishes for this process to spectate a game.
        /// <para>If <see cref="AutoEvents"/> is true then this event will execute on a different thread. If it is not true however, then this event is not invoked untill <see cref="Invoke"/> and will be on the calling thread.</para>
        /// </summary>
        public event OnSpectateEvent OnSpectate;
        /// <summary>
        /// Called when another discord user requests permission to join this game.
        /// <para>This event is not invoked untill <see cref="Invoke"/> is executed.</para>
        /// </summary>
        public event OnJoinRequestedEvent OnJoinRequested;
        /// <summary>
        /// The connection to the discord client was succesfull. This is called before <see cref="MessageType.Ready"/>.
        /// <para>If <see cref="AutoEvents"/> is true then this event will execute on a different thread. If it is not true however, then this event is not invoked untill <see cref="Invoke"/> and will be on the calling thread.</para>
        /// </summary>
        public event OnConnectionEstablishedEvent OnConnectionEstablished;
        /// <summary>
        /// Failed to establish any connection with discord. Discord is potentially not running?
        /// <para>If <see cref="AutoEvents"/> is true then this event will execute on a different thread. If it is not true however, then this event is not invoked untill <see cref="Invoke"/> and will be on the calling thread.</para>
        /// </summary>
        public event OnConnectionFailedEvent OnConnectionFailed;
        /// <summary>
        /// The RPC Connection has sent a message. Called before any other event and executed from the RPC Thread.
        /// </summary>
        public event OnRpcMessageEvent OnRpcMessage;
        #endregion Events
        #region Initialization
        /// <summary>
        /// Creates a new Discord RPC Client which can be used to send Rich Presence and receive Join / Spectate events.
        /// </summary>
        /// <param name="applicationID">The ID of the application created at discord's developers portal.</param>
        public DiscordRpcClient(string applicationID) : this(applicationID, -1) { }
        /// <summary>
        /// Creates a new Discord RPC Client which can be used to send Rich Presence and receive Join / Spectate events. This constructor exposes more advance features such as custom NamedPipeClients and Loggers.
        /// </summary>
        /// <param name="applicationID">The ID of the application created at discord's developers portal.</param>
        /// <param name="pipe">The pipe to connect too. If -1, then the client will scan for the first available instance of Discord.</param>
        /// <param name="logger">The logger used to report messages. If null, then a <see cref="NullLogger"/> will be created and logs will be ignored.</param>
        /// <param name="autoEvents">Should events be automatically invoked from the RPC Thread as they arrive from discord?</param>
        /// <param name="client">The pipe client to use and communicate to discord through. If null, the default <see cref="ManagedNamedPipeClient"/> will be used.</param>
        public DiscordRpcClient(string applicationID, int pipe = -1, ILogger logger = null, bool autoEvents = true, INamedPipeClient client = null)
            //Make sure appID is NOT null.
            if (string.IsNullOrEmpty(applicationID))
                throw new ArgumentNullException("applicationID");
            //Ensure we actually have json ahead of time. If statement is pointless, but its there just to ensure there is no unused warnings.
            var jsonConverterType = typeof(Newtonsoft.Json.JsonConverter);
            if (jsonConverterType == null) throw new Exception("JsonConverter Type Not Found");
            //Store the properties
            ApplicationID = applicationID.Trim();
            TargetPipe = pipe;
            ProcessID = System.Diagnostics.Process.GetCurrentProcess().Id;
            HasRegisteredUriScheme = false;
            AutoEvents = autoEvents;
            SkipIdenticalPresence = true;
            //Prepare the logger
            _logger = logger ?? new NullLogger();
            //Create the RPC client, giving it the important details
            connection = new RpcConnection(ApplicationID, ProcessID, TargetPipe, client ?? new ManagedNamedPipeClient(), autoEvents ? 0 : 128U)
                ShutdownOnly = _shutdownOnly,
                Logger = _logger
            //Subscribe to its event
            connection.OnRpcMessage += (sender, msg) =>
                if (OnRpcMessage != null)
                    OnRpcMessage.Invoke(this, msg);
                if (AutoEvents)
                    ProcessMessage(msg);
        #endregion Initialization
        #region Message Handling
        /// <summary>
        /// Dequeues all the messages from Discord, processes them and then invoke appropriate event handlers. This will process the message and update the internal state before invoking the events. Returns the messages that were invoked in the order they were invoked.
        /// <para>This method cannot be used if <see cref="AutoEvents"/> is enabled.</para>
        /// </summary>
        /// <returns>Returns the messages that were invoked and in the order they were invoked.</returns>
        public IMessage[] Invoke()
            if (AutoEvents)
                Logger.Error("Cannot Invoke client when AutomaticallyInvokeEvents has been set.");
                return new IMessage[0];
                //throw new InvalidOperationException("Cannot Invoke client when AutomaticallyInvokeEvents has been set.");
            //Dequeue all the messages and process them
            IMessage[] messages = connection.DequeueMessages();
            for (int i = 0; i < messages.Length; i++)
                //Do a bit of pre-processing
                var message = messages[i];
                ProcessMessage(message);
            //Finally, return the messages
            return messages;
        /// <summary>
        /// Processes the message, updating our internal state and then invokes the events.
        /// </summary>
        /// <param name="message"></param>
		private void ProcessMessage(IMessage message)
            if (message == null) return;
            switch (message.Type)
                //We got a update, so we will update our current presence
                case MessageType.PresenceUpdate:
                    lock (_sync)
                        var pm = message as PresenceMessage;
                        if (pm != null)
                            //We need to merge these presences together
                            if (CurrentPresence == null)
                                CurrentPresence = pm.Presence;
                            else if (pm.Presence == null)
                                CurrentPresence = null;
                                CurrentPresence.Merge(pm.Presence);
                            //Update the message
                            pm.Presence = CurrentPresence;
                    break;
                //Update our configuration
                case MessageType.Ready:
                    var rm = message as ReadyMessage;
                    if (rm != null)
                        lock (_sync)
                            Configuration = rm.Configuration;
                            CurrentUser = rm.User;
                        //Resend our presence and subscription
                        SynchronizeState();
                    break;
                //Update the request's CDN for the avatar helpers
                case MessageType.JoinRequest:
                    if (Configuration != null)
                        //Update the User object within the join request if the current Cdn
                        var jrm = message as JoinRequestMessage;
                        if (jrm != null) jrm.User.SetConfiguration(Configuration);
                    break;
                case MessageType.Subscribe:
                    lock (_sync)
                        var sub = message as SubscribeMessage;
                        Subscription |= sub.Event;
                    break;
                case MessageType.Unsubscribe:
                    lock (_sync)
                        var unsub = message as UnsubscribeMessage;
                        Subscription &= ~unsub.Event;
                    break;
                //We got a message we dont know what to do with.
                default:
                    break;
            //Invoke the appropriate methods
            switch (message.Type)
                case MessageType.Ready:
                    if (OnReady != null) OnReady.Invoke(this, message as ReadyMessage);
                    break;
                case MessageType.Close:
                    if (OnClose != null) OnClose.Invoke(this, message as CloseMessage);
                    break;
                case MessageType.Error:
                    if (OnError != null) OnError.Invoke(this, message as ErrorMessage);
                    break;
                case MessageType.PresenceUpdate:
                    if (OnPresenceUpdate != null) OnPresenceUpdate.Invoke(this, message as PresenceMessage);
                    break;
                case MessageType.Subscribe:
                    if (OnSubscribe != null) OnSubscribe.Invoke(this, message as SubscribeMessage);
                    break;
                case MessageType.Unsubscribe:
                    if (OnUnsubscribe != null) OnUnsubscribe.Invoke(this, message as UnsubscribeMessage);
                    break;
                case MessageType.Join:
                    if (OnJoin != null) OnJoin.Invoke(this, message as JoinMessage);
                    break;
                case MessageType.Spectate:
                    if (OnSpectate != null) OnSpectate.Invoke(this, message as SpectateMessage);
                    break;
                case MessageType.JoinRequest:
                    if (OnJoinRequested != null) OnJoinRequested.Invoke(this, message as JoinRequestMessage);
                    break;
                case MessageType.ConnectionEstablished:
                    if (OnConnectionEstablished != null) OnConnectionEstablished.Invoke(this, message as ConnectionEstablishedMessage);
                    break;
                case MessageType.ConnectionFailed:
                    if (OnConnectionFailed != null) OnConnectionFailed.Invoke(this, message as ConnectionFailedMessage);
                    break;
                default:
                    //This in theory can never happen, but its a good idea as a reminder to update this part of the library if any new messages are implemented.
                    Logger.Error("Message was queued with no appropriate handle! {0}", message.Type);
                    break;
        #endregion Message Handling
        /// <summary>
        /// Respond to a Join Request. All requests will timeout after 30 seconds.
        /// <para>Because of the 30 second timeout, it is recommended to call <seealso cref="Invoke"/> faster than every 15 seconds to give your users adequate time to respond to the request.</para>
        /// </summary>
        /// <param name="request">The request that is being responded too.</param>
        /// <param name="acceptRequest">Accept the join request.</param>
        public void Respond(JoinRequestMessage request, bool acceptRequest)
            if (IsDisposed)
                throw new ObjectDisposedException("Discord IPC Client");
            if (connection == null)
                throw new ObjectDisposedException("Connection", "Cannot initialize as the connection has been deinitialized");
            if (!IsInitialized)
                throw new UninitializedException();
            connection.EnqueueCommand(new RespondCommand() { Accept = acceptRequest, UserID = request.User.ID.ToString() });
        /// <summary>
        /// Sets the Rich Presence.
        /// </summary>
        /// <param name="presence">The Rich Presence to set on the current Discord user.</param>
        public void SetPresence(RichPresence presence)
            if (IsDisposed)
                throw new ObjectDisposedException("Discord IPC Client");
            if (connection == null)
                throw new ObjectDisposedException("Connection", "Cannot initialize as the connection has been deinitialized");
            if (!IsInitialized)
                Logger.Warning("The client is not yet initialized, storing the presence as a state instead.");
            //Send the event
            if (!presence)
                //Clear the presence
                if (!SkipIdenticalPresence || CurrentPresence != null)
                    connection.EnqueueCommand(new PresenceCommand() { PID = this.ProcessID, Presence = null });
            else
                //Send valid presence
                //Validate the presence with our settings
                if (presence.HasSecrets() && !HasRegisteredUriScheme)
                    throw new BadPresenceException("Cannot send a presence with secrets as this object has not registered a URI scheme. Please enable the uri scheme registration in the DiscordRpcClient constructor.");
                if (presence.HasParty() && presence.Party.Max < presence.Party.Size)
                    throw new BadPresenceException("Presence maximum party size cannot be smaller than the current size.");
                if (presence.HasSecrets() && !presence.HasParty())
                    Logger.Warning("The presence has set the secrets but no buttons will show as there is no party available.");
                //Send the presence, but only if we are not skipping
                if (!SkipIdenticalPresence || !presence.Matches(CurrentPresence))
                    connection.EnqueueCommand(new PresenceCommand() { PID = this.ProcessID, Presence = presence.Clone() });
            //Update our local store
            lock (_sync) { CurrentPresence = presence != null ? presence.Clone() : null; }
        #region Updates
        /// <summary>
        /// Updates only the <see cref="RichPresence.Details"/> of the <see cref="CurrentPresence"/> and sends the updated presence to Discord. Returns the newly edited Rich Presence.
        /// </summary>
        /// <param name="details">The details of the Rich Presence</param>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateDetails(string details)
            if (!IsInitialized)
                throw new UninitializedException();
            lock (_sync)
                if (CurrentPresence == null) CurrentPresence = new RichPresence();
                CurrentPresence.Details = details;
                SetPresence(CurrentPresence);
            return CurrentPresence;
        /// <summary>
        /// Updates only the <see cref="RichPresence.State"/> of the <see cref="CurrentPresence"/> and sends the updated presence to Discord. Returns the newly edited Rich Presence.
        /// </summary>
        /// <param name="state">The state of the Rich Presence</param>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateState(string state)
            if (!IsInitialized)
                throw new UninitializedException();
            lock (_sync)
                if (CurrentPresence == null) CurrentPresence = new RichPresence();
                CurrentPresence.State = state;
                SetPresence(CurrentPresence);
            return CurrentPresence;
        /// <summary>
        /// Updates only the <see cref="RichPresence.Party"/> of the <see cref="CurrentPresence"/> and sends the updated presence to Discord. Returns the newly edited Rich Presence.
        /// </summary>
        /// <param name="party">The party of the Rich Presence</param>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateParty(Party party)
            if (!IsInitialized)
                throw new UninitializedException();
            lock (_sync)
                if (CurrentPresence == null) CurrentPresence = new RichPresence();
                CurrentPresence.Party = party;
            SetPresence(CurrentPresence);
            return CurrentPresence;
        /// <summary>
        /// Updates the <see cref="Party.Size"/> of the <see cref="CurrentPresence"/> and sends the update presence to Discord. Returns the newly edited Rich Presence.
        /// <para>Will return null if no presence exists and will throw a new <see cref="NullReferenceException"/> if the Party does not exist.</para>
        /// </summary>
        /// <param name="size">The new size of the party. It cannot be greater than <see cref="Party.Max"/></param>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdatePartySize(int size)
            if (!IsInitialized)
                throw new UninitializedException();
            if (CurrentPresence == null) return null;
            if (CurrentPresence.Party == null)
                throw new BadPresenceException("Cannot set the size of the party if the party does not exist");
            try { UpdatePartySize(size, CurrentPresence.Party.Max); } catch (Exception) { throw; }
            return CurrentPresence;
        /// <summary>
        /// Updates the <see cref="Party.Size"/> of the <see cref="CurrentPresence"/> and sends the update presence to Discord. Returns the newly edited Rich Presence.
        /// <para>Will return null if no presence exists and will throw a new <see cref="NullReferenceException"/> if the Party does not exist.</para>
        /// </summary>
        /// <param name="size">The new size of the party. It cannot be greater than <see cref="Party.Max"/></param>
        /// <param name="max">The new size of the party. It cannot be smaller than <see cref="Party.Size"/></param>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdatePartySize(int size, int max)
            if (!IsInitialized)
                throw new UninitializedException();
            if (CurrentPresence == null) return null;
            if (CurrentPresence.Party == null)
                throw new BadPresenceException("Cannot set the size of the party if the party does not exist");
            lock (_sync)
                CurrentPresence.Party.Size = size;
                CurrentPresence.Party.Max = max;
            SetPresence(CurrentPresence);
            return CurrentPresence;
        /// <summary>
        /// Updates the large <see cref="Assets"/> of the <see cref="CurrentPresence"/> and sends the updated presence to Discord. Both <paramref name="key"/> and <paramref name="tooltip"/> are optional and will be ignored it null.
        /// </summary>
        /// <param name="key">Optional: The new key to set the asset too</param>
        /// <param name="tooltip">Optional: The new tooltip to display on the asset</param>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateLargeAsset(string key = null, string tooltip = null)
            if (!IsInitialized)
                throw new UninitializedException();
            lock (_sync)
                if (CurrentPresence == null) CurrentPresence = new RichPresence();
                if (CurrentPresence.Assets == null) CurrentPresence.Assets = new Assets();
                CurrentPresence.Assets.LargeImageKey = key ?? CurrentPresence.Assets.LargeImageKey;
                CurrentPresence.Assets.LargeImageText = tooltip ?? CurrentPresence.Assets.LargeImageText;
            SetPresence(CurrentPresence);
            return CurrentPresence;
        /// <summary>
        /// Updates the small <see cref="Assets"/> of the <see cref="CurrentPresence"/> and sends the updated presence to Discord. Both <paramref name="key"/> and <paramref name="tooltip"/> are optional and will be ignored it null.
        /// </summary>
        /// <param name="key">Optional: The new key to set the asset too</param>
        /// <param name="tooltip">Optional: The new tooltip to display on the asset</param>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateSmallAsset(string key = null, string tooltip = null)
            if (!IsInitialized)
                throw new UninitializedException();
            lock (_sync)
                if (CurrentPresence == null) CurrentPresence = new RichPresence();
                if (CurrentPresence.Assets == null) CurrentPresence.Assets = new Assets();
                CurrentPresence.Assets.SmallImageKey = key ?? CurrentPresence.Assets.SmallImageKey;
                CurrentPresence.Assets.SmallImageText = tooltip ?? CurrentPresence.Assets.SmallImageText;
            SetPresence(CurrentPresence);
            return CurrentPresence;
        /// <summary>
        /// Updates the <see cref="Secrets"/> of the <see cref="CurrentPresence"/> and sends the updated presence to Discord. Will override previous secret entirely.
        /// </summary>
        /// <param name="secrets">The new secret to send to discord.</param>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateSecrets(Secrets secrets)
            if (!IsInitialized)
                throw new UninitializedException();
            lock (_sync)
                if (CurrentPresence == null) CurrentPresence = new RichPresence();
                CurrentPresence.Secrets = secrets;
            SetPresence(CurrentPresence);
            return CurrentPresence;
        /// <summary>
        /// Sets the start time of the <see cref="CurrentPresence"/> to now and sends the updated presence to Discord.
        /// </summary>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateStartTime()
        { try { return UpdateStartTime(DateTime.UtcNow); } catch (Exception) { throw; } }
        /// <summary>
        /// Sets the start time of the <see cref="CurrentPresence"/> and sends the updated presence to Discord.
        /// </summary>
        /// <param name="time">The new time for the start</param>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateStartTime(DateTime time)
            if (!IsInitialized)
                throw new UninitializedException();
            lock (_sync)
                if (CurrentPresence == null) CurrentPresence = new RichPresence();
                if (CurrentPresence.Timestamps == null) CurrentPresence.Timestamps = new Timestamps();
                CurrentPresence.Timestamps.Start = time;
            SetPresence(CurrentPresence);
            return CurrentPresence;
        /// <summary>
        /// Sets the end time of the <see cref="CurrentPresence"/> to now and sends the updated presence to Discord.
        /// </summary>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateEndTime()
        { try { return UpdateEndTime(DateTime.UtcNow); } catch (Exception) { throw; } }
        /// <summary>
        /// Sets the end time of the <see cref="CurrentPresence"/> and sends the updated presence to Discord.
        /// </summary>
        /// <param name="time">The new time for the end</param>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateEndTime(DateTime time)
            if (!IsInitialized)
                throw new UninitializedException();
            lock (_sync)
                if (CurrentPresence == null) CurrentPresence = new RichPresence();
                if (CurrentPresence.Timestamps == null) CurrentPresence.Timestamps = new Timestamps();
                CurrentPresence.Timestamps.End = time;
            SetPresence(CurrentPresence);
            return CurrentPresence;
        /// <summary>
        /// Sets the start and end time of <see cref="CurrentPresence"/> to null and sends it to Discord.
        /// </summary>
        /// <returns>Updated Rich Presence</returns>
        public RichPresence UpdateClearTime()
            if (!IsInitialized)
                throw new UninitializedException();
            lock (_sync)
                if (CurrentPresence == null) return null;
                CurrentPresence.Timestamps = null;
            SetPresence(CurrentPresence);
            return CurrentPresence;
        #endregion Updates
        /// <summary>
        /// Clears the Rich Presence. Use this just before disposal to prevent ghosting.
        /// </summary>
        public void ClearPresence()
            if (IsDisposed)
                throw new ObjectDisposedException("Discord IPC Client");
            if (!IsInitialized)
                throw new UninitializedException();
            if (connection == null)
                throw new ObjectDisposedException("Connection", "Cannot initialize as the connection has been deinitialized");
            //Just a wrapper function for sending null
            SetPresence(null);
        #region Subscriptions
        /// <summary>
        /// Registers the application executable to a custom URI Scheme.
        /// <para>This is required for the Join and Spectate features. Discord will run this custom URI Scheme to launch your application when a user presses either of the buttons.</para>
        /// </summary>
        /// <param name="steamAppID">Optional Steam ID. If supplied, Discord will launch the game through steam instead of directly calling it.</param>
        /// <param name="executable">The path to the executable. If null, the path to the current executable will be used instead.</param>
        /// <returns></returns>
        public bool RegisterUriScheme(string steamAppID = null, string executable = null)
            var urischeme = new UriSchemeRegister(_logger, ApplicationID, steamAppID, executable);
            return HasRegisteredUriScheme = urischeme.RegisterUriScheme();
        /// <summary>
        /// Subscribes to an event sent from discord. Used for Join / Spectate feature.
        /// <para>Requires the UriScheme to be registered.</para>
        /// </summary>
        /// <param name="type">The event type to subscribe to</param>
        public void Subscribe(EventType type)
        { SetSubscription(Subscription | type); }
        /// <summary>
        ///
        /// </summary>
        /// <param name="type"></param>
        [System.Obsolete("Replaced with Unsubscribe", true)]
        public void Unubscribe(EventType type)
        { SetSubscription(Subscription & ~type); }
        /// <summary>
        /// Unsubscribe from the event sent by discord. Used for Join / Spectate feature.
        /// <para>Requires the UriScheme to be registered.</para>
        /// </summary>
        /// <param name="type">The event type to unsubscribe from</param>
        public void Unsubscribe(EventType type)
        { SetSubscription(Subscription & ~type); }
        /// <summary>
        /// Sets the subscription to the events sent from Discord.
        /// <para>Requires the UriScheme to be registered.</para>
        /// </summary>
        /// <param name="type">The new subscription as a flag. Events selected in the flag will be subscribed too and the other events will be unsubscribed.</param>
        public void SetSubscription(EventType type)
            if (IsInitialized)
                //Calculate what needs to be unsubscrinbed
                SubscribeToTypes(Subscription & ~type, true);
                SubscribeToTypes(~Subscription & type, false);
            else
                Logger.Warning("Client has not yet initialized, but events are being subscribed too. Storing them as state instead.");
            lock (_sync)
                Subscription = type;
        /// <summary>
        /// Simple helper function that will subscribe to the specified types in the flag.
        /// </summary>
        /// <param name="type">The flag to subscribe to</param>
        /// <param name="isUnsubscribe">Represents if the unsubscribe payload should be sent instead.</param>
        private void SubscribeToTypes(EventType type, bool isUnsubscribe)
            //Because of SetSubscription, this can actually be none as there is no differences.
            //If that is the case, we should just stop here
            if (type == EventType.None) return;
            //We cannot do anything if we are disposed or missing our connection.
            if (IsDisposed)
                throw new ObjectDisposedException("Discord IPC Client");
            if (!IsInitialized)
                throw new UninitializedException();
            if (connection == null)
                throw new ObjectDisposedException("Connection", "Cannot initialize as the connection has been deinitialized");
            //We dont have the Uri Scheme registered, we should throw a exception to tell the user.
            if (!HasRegisteredUriScheme)
                throw new InvalidConfigurationException("Cannot subscribe/unsubscribe to an event as this application has not registered a URI Scheme. Call RegisterUriScheme().");
            //Add the subscribe command to be sent when the connection is able too
            if ((type & EventType.Spectate) == EventType.Spectate)
                connection.EnqueueCommand(new SubscribeCommand() { Event = RPC.Payload.ServerEvent.ActivitySpectate, IsUnsubscribe = isUnsubscribe });
            if ((type & EventType.Join) == EventType.Join)
                connection.EnqueueCommand(new SubscribeCommand() { Event = RPC.Payload.ServerEvent.ActivityJoin, IsUnsubscribe = isUnsubscribe });
            if ((type & EventType.JoinRequest) == EventType.JoinRequest)
                connection.EnqueueCommand(new SubscribeCommand() { Event = RPC.Payload.ServerEvent.ActivityJoinRequest, IsUnsubscribe = isUnsubscribe });
        #endregion Subscriptions
        /// <summary>
        /// Resends the current presence and subscription. This is used when Ready is called to keep the current state within discord.
        /// </summary>
        public void SynchronizeState()
            //Cannot sync over uninitialized connection
            if (!IsInitialized)
                throw new UninitializedException();
            //Set the presence and if we have registered the uri scheme, resubscribe.
            SetPresence(CurrentPresence);
            if (HasRegisteredUriScheme)
                SubscribeToTypes(Subscription, false);
        /// <summary>
        /// Attempts to initalize a connection to the Discord IPC.
        /// </summary>
        /// <returns></returns>
        public bool Initialize()
            if (IsDisposed)
                throw new ObjectDisposedException("Discord IPC Client");
            if (IsInitialized)
                throw new UninitializedException("Cannot initialize a client that is already initialized");
            if (connection == null)
                throw new ObjectDisposedException("Connection", "Cannot initialize as the connection has been deinitialized");
            return IsInitialized = connection.AttemptConnection();
        /// <summary>
        /// Attempts to disconnect and deinitialize the IPC connection while retaining the settings.
        /// </summary>
        public void Deinitialize()
            if (!IsInitialized)
                throw new UninitializedException("Cannot deinitialize a client that has not been initalized.");
            connection.Close();
            IsInitialized = false;
        /// <summary>
        /// Terminates the connection to Discord and disposes of the object.
        /// </summary>
        public void Dispose()
            if (IsDisposed) return;
            if (IsInitialized) Deinitialize();
            IsDisposed = true;
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

FilesExpand file tree

DiscordRpcClient.cs

Latest commit

History

DiscordRpcClient.cs

File metadata and controls
