Package live.crowdcontrol.cc4j

Interface IUserRecord

All Known Implementing Classes:
CCUserRecord, UserToken
public interface IUserRecord

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    getId()
    Gets the user's Crowd Control User ID.
    @NotNull String
    getName()
    Gets the user's display name.
    @NotNull String
    getOriginId()
    Gets the ID of the user on their home platform.
    @NotNull ProfileType
    getProfile()
    Gets the type of profile the user logged in with.

  • Method Details

    • getId

      @Pattern("^ccuid-[0-7][0-9a-hjkmnp-tv-z]{25}$") @NotNull @NotNull String getId()
      Gets the user's Crowd Control User ID.
      Returns:
      ccUID

    • getName

      @NotNull @NotNull String getName()
      Gets the user's display name.
      Returns:
      display name

    • getProfile

      @NotNull @NotNull ProfileType getProfile()
      Gets the type of profile the user logged in with.
      Returns:
      profile type

    • getOriginId

      @NotNull @NotNull String getOriginId()
      Gets the ID of the user on their home platform.
      Returns:
      origin id