Studio Types

• ListStudiosFailure

  Defines an interface that represents a failed "list studios" result.

  Members

  • errorCode ("server_error" | "not_authorized" | "not_logged_in")

    The error code.

  • errorMessage string

    The error message.

  • success false

• ListStudiosResult

  Defines the list of possible results for the os.listUserStudios(endpoint) function.

  A ListStudiosResult can be one of the following values:

  • ListStudiosSuccess
  • ListStudiosFailure

• ListStudiosSuccess

  Defines an interface that represents a successful "list studios" result.

  Members

  • studios ListedStudio[]

    The list of studios that the user is a member of.

  • success true

• ListedStudio

  Defines an interface that represents a studio that has been listed.

  Members

  • comId string

    The comId of this studio.

  • displayName string

    The name of the studio.

  • isPrimaryContact boolean

    Whether the user is the primary contact for this studio.

  • ownerStudioComId string

    The comId of the studio that owns this one.

  • role StudioAssignmentRole

    The role that the user has in the studio.

  • studioId string

    The ID of the studio.

  • subscriptionTier string

    The tier of the studio's subscription.

• StudioAssignmentRole

  Defines the list of possible studio roles that a user can be assigned.

  A StudioAssignmentRole can be one of the following values:

  • "admin"
  • "member"