Package discord4j.core.object.presence

Class Presence

    • Constructor Summary

      Constructors 
      Constructor Description
      Presence​(discord4j.discordjson.json.PresenceData data)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      discord4j.discordjson.json.gateway.StatusUpdate asStatusUpdate()
      Convert a received Presence into a StatusUpdate that can be used for sending an update.
      static discord4j.discordjson.json.gateway.StatusUpdate doNotDisturb()
      Create a status update to display a do-not-disturb status.
      static discord4j.discordjson.json.gateway.StatusUpdate doNotDisturb​(discord4j.discordjson.json.ActivityUpdateRequest activity)
      Create a status update to display a do-not-disturb status along with a custom activity.
      List<Activity> getActivities()
      Get the user's current activities.
      Optional<Activity> getActivity()
      Get a user's current activity, if present.
      Status getStatus()
      Get the user's status.
      Optional<Status> getStatus​(Status.Platform platform)
      Get the user's status for the given platform, if present.
      static discord4j.discordjson.json.gateway.StatusUpdate idle()
      Create a status update to display an idle status.
      static discord4j.discordjson.json.gateway.StatusUpdate idle​(discord4j.discordjson.json.ActivityUpdateRequest activity)
      Create a status update to display an idle status along with a custom activity.
      static discord4j.discordjson.json.gateway.StatusUpdate invisible()
      Create a status update to display an invisible status.
      static discord4j.discordjson.json.gateway.StatusUpdate online()
      Create a status update to display an online status.
      static discord4j.discordjson.json.gateway.StatusUpdate online​(discord4j.discordjson.json.ActivityUpdateRequest activity)
      Create a status update to display an online status along with a custom activity.
      String toString()  

    • Constructor Detail

      • Presence

        public Presence​(discord4j.discordjson.json.PresenceData data)

    • Method Detail

      • online

        public static discord4j.discordjson.json.gateway.StatusUpdate online()
        Create a status update to display an online status.
        Returns:
        a StatusUpdate for the ONLINE status

      • doNotDisturb

        public static discord4j.discordjson.json.gateway.StatusUpdate doNotDisturb()
        Create a status update to display a do-not-disturb status.
        Returns:
        a StatusUpdate for the DO_NOT_DISTURB status

      • idle

        public static discord4j.discordjson.json.gateway.StatusUpdate idle()
        Create a status update to display an idle status.
        Returns:
        a StatusUpdate for the IDLE status

      • invisible

        public static discord4j.discordjson.json.gateway.StatusUpdate invisible()
        Create a status update to display an invisible status.
        Returns:
        a StatusUpdate for the INVISIBLE status

      • getStatus

        public Status getStatus()
        Get the user's status.
        Returns:
        The user's status.

      • getStatus

        public Optional<Status> getStatus​(Status.Platform platform)
        Get the user's status for the given platform, if present.
        Parameters:
        platform - the platform to obtain a user status
        Returns:
        an Optional with the user's status for a given platform, or empty if not present.

      • getActivity

        public Optional<Activity> getActivity()
        Get a user's current activity, if present.
        Returns:
        an Optional with the user's activity, or empty if not present.

      • getActivities

        public List<Activity> getActivities()
        Get the user's current activities.
        Returns:
        The user's current activities.

      • asStatusUpdate

        public discord4j.discordjson.json.gateway.StatusUpdate asStatusUpdate()
        Convert a received Presence into a StatusUpdate that can be used for sending an update.
        Returns:
        a StatusUpdate with the contents of the current Presence data.