Package org.spongepowered.api.profile

Interface GameProfileProvider

    • Method Detail

      • basicProfile

        java.util.concurrent.CompletableFuture<GameProfile> basicProfile​(java.util.UUID uniqueId)
        Attempts to get a basic GameProfile for the given unique id.

        Basic game profiles don't include any profile properties.

        The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given unique id.

        Parameters:
        uniqueId - The unique id
        Returns:
        The profile found for the given unique id

      • basicProfile

        default java.util.concurrent.CompletableFuture<GameProfile> basicProfile​(java.lang.String name)
        Attempts to get a basic GameProfile for the given name.

        Basic game profiles don't include any profile properties.

        The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given name.

        The requested name is matched case insensitively, the corrected name will be present in the GameProfile.

        Parameters:
        name - The name
        Returns:
        The profile found for the given name

      • basicProfile

        java.util.concurrent.CompletableFuture<GameProfile> basicProfile​(java.lang.String name,
                                                                 @Nullable java.time.Instant time)
        Attempts to get a basic GameProfile for the given name.

        Basic game profiles don't include any profile properties.

        The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given name.

        The requested name is matched case insensitively, the corrected name will be present in the GameProfile.

        Parameters:
        name - The name
        time - The time at which the name was assigned to a specific profile, or null if current
        Returns:
        The profile found for the given name

      • basicProfiles

        default java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,​GameProfile>> basicProfiles​(java.lang.Iterable<java.lang.String> names)
        Attempts to get a basic GameProfiles for the given names.

        Basic game profiles don't include any profile properties.

        The requested names are matched case insensitively, the corrected names will be present in the GameProfiles.

        Parameters:
        names - The names
        Returns:
        The profiles found for the given names

      • basicProfiles

        java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,​GameProfile>> basicProfiles​(java.lang.Iterable<java.lang.String> names,
                                                                                                        @Nullable java.time.Instant time)
        Attempts to get a basic GameProfiles for the given names.

        Basic game profiles don't include any profile properties.

        The requested names are matched case insensitively, the corrected names will be present in the GameProfiles.

        Parameters:
        names - The names
        time - The time at which the names were assigned to specific profiles, or null if current
        Returns:
        The profiles found for the given names

      • profile

        default java.util.concurrent.CompletableFuture<GameProfile> profile​(GameProfile profile)
        Attempts to get a full GameProfile for the given profile.

        The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the unique id of the given profile.

        Parameters:
        profile - The profile
        Returns:
        The profile found for the given unique id

      • profile

        default java.util.concurrent.CompletableFuture<GameProfile> profile​(GameProfile profile,
                                                                    boolean signed)
        Attempts to get a full GameProfile for the given profile.

        The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the unique id of the given profile.

        Parameters:
        profile - The profile
        signed - Whether property values should be signed
        Returns:
        The profile found for the given unique id

      • profile

        default java.util.concurrent.CompletableFuture<GameProfile> profile​(java.lang.String name)
        Attempts to get a full GameProfile for the given name.

        The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given name.

        Parameters:
        name - The name
        Returns:
        The profile found for the given name

      • profile

        default java.util.concurrent.CompletableFuture<GameProfile> profile​(java.util.UUID uniqueId)
        Attempts to get a full GameProfile for the given unique id.

        The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given unique id.

        Parameters:
        uniqueId - The unique id
        Returns:
        The profile found for the given unique id

      • profile

        java.util.concurrent.CompletableFuture<GameProfile> profile​(java.lang.String name,
                                                            boolean signed)
        Attempts to get a full GameProfile for the given name.

        The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given name.

        Parameters:
        name - The name
        signed - Whether property values should be signed
        Returns:
        The profile found for the given name

      • profile

        java.util.concurrent.CompletableFuture<GameProfile> profile​(java.util.UUID uniqueId,
                                                            boolean signed)
        Attempts to get a full GameProfile for the given unique id.

        The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given unique id.

        Parameters:
        uniqueId - The unique id
        signed - Whether property values should be signed
        Returns:
        The profile found for the given unique id