Class SteamUnifiedMessages


  • public class SteamUnifiedMessages
    extends ClientMsgHandler
    Since:
    2023-01-04

    This handler is used for interacting with Steamworks unified messaging

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void handleMsg​(IPacketMsg packetMsg)
      Handles a client message.
      <TRequest extends com.google.protobuf.GeneratedMessageV3.Builder<TRequest>>
      JobID
      sendMessage​(java.lang.String rpcName, com.google.protobuf.GeneratedMessageV3 message)
      Sends a message.
      <TRequest extends com.google.protobuf.GeneratedMessageV3.Builder<TRequest>>
      void
      sendNotification​(java.lang.String rpcName, com.google.protobuf.GeneratedMessageV3 message)
      Sends a notification.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SteamUnifiedMessages

        public SteamUnifiedMessages()
    • Method Detail

      • handleMsg

        public void handleMsg​(IPacketMsg packetMsg)
        Description copied from class: ClientMsgHandler
        Handles a client message. This should not be called directly.
        Specified by:
        handleMsg in class ClientMsgHandler
        Parameters:
        packetMsg - The packet message that contains the data.
      • sendMessage

        public <TRequest extends com.google.protobuf.GeneratedMessageV3.Builder<TRequest>> JobID sendMessage​(java.lang.String rpcName,
                                                                                                             com.google.protobuf.GeneratedMessageV3 message)
        Sends a message. Results are returned in a ServiceMethodResponse.
        Type Parameters:
        TRequest - The type of protobuf object.
        Parameters:
        rpcName - Name of the RPC endpoint. Takes the format ServiceName.RpcName
        message - The message to send.
        Returns:
        The JobID of the request. This can be used to find the appropriate ServiceMethodResponse.
      • sendNotification

        public <TRequest extends com.google.protobuf.GeneratedMessageV3.Builder<TRequest>> void sendNotification​(java.lang.String rpcName,
                                                                                                                 com.google.protobuf.GeneratedMessageV3 message)
        Sends a notification.
        Type Parameters:
        TRequest - The type of protobuf object.
        Parameters:
        rpcName - Name of the RPC endpoint. Takes the format ServiceName.RpcName
        message - The message to send.