TeamUser

On this page:

TeamUser

The TeamUser object is used on the client side to represent a user in the context of a team, providing minimal information about the user, including their ID and team-specific profile.

It is usually obtained by calling team.useUsers() or team.listUsers() on a Team object.

Table of Contents

1type TeamUser = {
2  id: string;  //$stack-link-to:#teamuserid
3  teamProfile: TeamProfile;  //$stack-link-to:#teamuserteamprofile
4};

teamUser.id

The ID of the user.

Type Definition

1declare const id: string;

teamUser.teamProfile

The team profile of the user as a TeamProfile object.

Type Definition

1declare const teamProfile: TeamProfile;

ServerTeamUser

The ServerTeamUser object is used on the server side to represent a user within a team. Besides the team profile, it also includes all the functionality of a ServerUser.

It is usually obtained by calling serverTeam.listUsers() on a ServerTeam object.

Table of Contents

1type ServerTeamUser =
2  // Inherits all functionality from TeamUser
3  & TeamUser //$stack-link-to:#teamuser
4  // Inherits all functionality from ServerUser
5  & ServerUser //$stack-link-to:./user#serveruser
6  & {
7    teamProfile: ServerTeamProfile;  //$stack-link-to:#serverteamuserteamprofile
8  };

serverTeamUser.teamProfile

The team profile of the user as a ServerTeamProfile object.

Type Definition

1declare const teamProfile: ServerTeamProfile;