Class TeamServiceBase

Namespace

Tharga.Team

Assembly

Tharga.Team.dll

public abstract class TeamServiceBase : ITeamService

Inheritance

object

TeamServiceBase

Implements

ITeamService

Derived

TeamServiceRepositoryBase<TTeamEntity, TMember>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TeamServiceBase(IUserService, ILogger<TeamServiceBase>, IIconStore)

protected TeamServiceBase(IUserService userService, ILogger<TeamServiceBase> logger = null, IIconStore iconStore = null)

Parameters

userService IUserService

logger ILogger<TeamServiceBase>

iconStore IIconStore

Methods

AddMemberAsync(string, InviteUserModel)

public Task AddMemberAsync(string teamKey, InviteUserModel model)

Parameters

teamKey string

model InviteUserModel

Returns

Task

AddTeamMemberAsync(string, InviteUserModel)

protected abstract Task AddTeamMemberAsync(string teamKey, InviteUserModel model)

Parameters

teamKey string

model InviteUserModel

Returns

Task

ClearTeamIconAsync(string)

Clears the team's icon and deletes the stored bytes. Gated by team:manage.

public Task ClearTeamIconAsync(string teamKey)

Parameters

teamKey string

Returns

Task

CreateTeamAsync(string)

public Task<ITeam> CreateTeamAsync(string name)

Parameters

name string

Returns

Task<ITeam>

CreateTeamAsync(string, string, IUser, string)

protected abstract Task<ITeam> CreateTeamAsync(string teamKey, string name, IUser user, string displayName = null)

Parameters

teamKey string

name string

user IUser

displayName string

Returns

Task<ITeam>

DeleteTeamAsync(string)

protected abstract Task DeleteTeamAsync(string teamKey)

Parameters

teamKey string

Returns

Task

DeleteTeamAsync<TMember>(string)

public Task DeleteTeamAsync<TMember>(string teamKey) where TMember : ITeamMember

Parameters

teamKey string

Returns

Task

Type Parameters

TMember

GetAllTeamsAsync()

Every team, regardless of membership. Requires the Read system scope.

public virtual IAsyncEnumerable<ITeam> GetAllTeamsAsync()

Returns

IAsyncEnumerable<ITeam>

Remarks

Discovery only — the returned teams carry no implied access. Acting inside a team the caller is not a member of still depends on that team's consent. Use GetTeamsAsync() for the caller's own teams; this method is for oversight surfaces (support, administration).

GetAllTeamsAsync<TMember>()

Every team, regardless of membership. Requires the Read system scope.

public virtual IAsyncEnumerable<ITeam<TMember>> GetAllTeamsAsync<TMember>() where TMember : ITeamMember

Returns

IAsyncEnumerable<ITeam<TMember>>

Type Parameters

TMember

Remarks

Discovery only — the returned teams carry no implied access. Acting inside a team the caller is not a member of still depends on that team's consent. Use GetTeamsAsync() for the caller's own teams; this method is for oversight surfaces (support, administration).

GetAllTeamsInternalAsync()

Backs GetAllTeamsAsync(). Virtual rather than abstract so existing derived services keep compiling; the default returns nothing, and storage-backed bases override it.

protected virtual IAsyncEnumerable<ITeam> GetAllTeamsInternalAsync()

Returns

IAsyncEnumerable<ITeam>

GetConsentedTeamsAsync(string[])

public IAsyncEnumerable<ITeam> GetConsentedTeamsAsync(string[] userRoles)

Parameters

userRoles string[]

Returns

IAsyncEnumerable<ITeam>

GetConsentedTeamsInternalAsync(string[])

protected abstract IAsyncEnumerable<ITeam> GetConsentedTeamsInternalAsync(string[] userRoles)

Parameters

userRoles string[]

Returns

IAsyncEnumerable<ITeam>

GetInvitedMemberNameAsync(string, string)

Look up the (admin-entered) Name of the member identified by inviteKey inside the given team. Used to capture the invitation Name before accept clears it, so it can be promoted to User.Name. Default implementation returns null; derivatives that have access to the typed team document override it.

protected virtual Task<string> GetInvitedMemberNameAsync(string teamKey, string inviteKey)

Parameters

teamKey string

inviteKey string

Returns

Task<string>

GetMembersAsync(string)

public virtual IAsyncEnumerable<ITeamMember> GetMembersAsync(string teamKey)

Parameters

teamKey string

Returns

IAsyncEnumerable<ITeamMember>

GetTeamAsync(string)

protected abstract Task<ITeam> GetTeamAsync(string teamKey)

Parameters

teamKey string

Returns

Task<ITeam>

GetTeamAsync<TMember>(string)

public Task<ITeam<TMember>> GetTeamAsync<TMember>(string teamKey) where TMember : ITeamMember

Parameters

teamKey string

Returns

Task<ITeam<TMember>>

Type Parameters

TMember

GetTeamByKeyAsync(string)

A team by key, regardless of the caller's membership — a non-generic exact read for call sites with no TMember to hand (e.g. the audit decorator capturing a "before" value for a consent change made by a non-member acting through consent). Returns null when the team does not exist.

public Task<ITeam> GetTeamByKeyAsync(string teamKey)

Parameters

teamKey string

Returns

Task<ITeam>

GetTeamCustomRolesAsync(string)

public Task<IReadOnlyList<TenantRoleDefinition>> GetTeamCustomRolesAsync(string teamKey)

Parameters

teamKey string

Returns

Task<IReadOnlyList<TenantRoleDefinition>>

GetTeamMemberAsync(string, string)

public Task<ITeamMember> GetTeamMemberAsync(string teamKey, string userKey)

Parameters

teamKey string

userKey string

Returns

Task<ITeamMember>

GetTeamMembersAsync(string, string)

protected abstract Task<ITeamMember> GetTeamMembersAsync(string teamKey, string userKey)

Parameters

teamKey string

userKey string

Returns

Task<ITeamMember>

GetTeamsAsync()

public IAsyncEnumerable<ITeam> GetTeamsAsync()

Returns

IAsyncEnumerable<ITeam>

GetTeamsAsync(IUser)

protected abstract IAsyncEnumerable<ITeam> GetTeamsAsync(IUser user)

Parameters

user IUser

Returns

IAsyncEnumerable<ITeam>

GetTeamsAsync<TMember>()

public IAsyncEnumerable<ITeam<TMember>> GetTeamsAsync<TMember>() where TMember : ITeamMember

Returns

IAsyncEnumerable<ITeam<TMember>>

Type Parameters

TMember

RemoveMemberAsync(string, string)

public Task RemoveMemberAsync(string teamKey, string userKey)

Parameters

teamKey string

userKey string

Returns

Task

RemoveTeamMemberAsync(string, string)

protected abstract Task RemoveTeamMemberAsync(string teamKey, string userKey)

Parameters

teamKey string

userKey string

Returns

Task

RemoveUserFromAllTeamsAsync(string)

Removes the user from every team they appear in, regardless of membership state. Backs user deletion (DeleteUserAsync(string, bool, CancellationToken)); requires the Manage system scope. Returns the number of teams the user was removed from.

public Task<int> RemoveUserFromAllTeamsAsync(string userKey)

Parameters

userKey string

Returns

Task<int>

RemoveUserFromAllTeamsInternalAsync(string)

Backs RemoveUserFromAllTeamsAsync(string). Virtual rather than abstract so existing derived services keep compiling; the default throws rather than returning 0, since a silent no-op on a deletion path would hide the missing implementation. Storage-backed bases override it.

protected virtual Task<int> RemoveUserFromAllTeamsInternalAsync(string userKey)

Parameters

userKey string

Returns

Task<int>

RenameTeamAsync<TMember>(string, string)

public Task RenameTeamAsync<TMember>(string teamKey, string name) where TMember : ITeamMember

Parameters

teamKey string

name string

Returns

Task

Type Parameters

TMember

ResolveDisplayName(IUser)

public static string ResolveDisplayName(IUser user)

Parameters

user IUser

Returns

string

SetInvitationResponseAsync(string, string, string, bool)

public Task SetInvitationResponseAsync(string teamKey, string userKey, string inviteKey, bool accept)

Parameters

teamKey string

userKey string

inviteKey string

accept bool

Returns

Task

SetMemberLastSeenAsync(string)

public Task SetMemberLastSeenAsync(string teamKey)

Parameters

teamKey string

Returns

Task

SetMemberNameAsync(string, string, string)

public Task SetMemberNameAsync(string teamKey, string userKey, string name)

Parameters

teamKey string

userKey string

name string

Returns

Task

SetMemberRoleAsync(string, string, AccessLevel)

Sets a member's access level. Ownership is not settable here — it changes only through TransferOwnershipAsync<TMember>(string, string), which checks that the caller is the current owner.

public Task SetMemberRoleAsync(string teamKey, string userKey, AccessLevel accessLevel)

Parameters

teamKey string

userKey string

accessLevel AccessLevel

Returns

Task

Remarks

Both directions are refused. Granting Owner would let any holder of the member-manage scope promote themselves past that check; demoting the sitting owner would leave a team nobody can transfer, because transfer requires the caller to be the owner. Transfer itself is unaffected — it calls the protected SetTeamMemberRoleAsync(string, string, AccessLevel) directly.

SetMemberScopeOverridesAsync(string, string, string[])

public Task SetMemberScopeOverridesAsync(string teamKey, string userKey, string[] scopeOverrides)

Parameters

teamKey string

userKey string

scopeOverrides string[]

Returns

Task

SetMemberTenantRolesAsync(string, string, string[])

public Task SetMemberTenantRolesAsync(string teamKey, string userKey, string[] tenantRoles)

Parameters

teamKey string

userKey string

tenantRoles string[]

Returns

Task

SetTeamConsentAsync(string, string[], AccessLevel?)

public Task SetTeamConsentAsync(string teamKey, string[] consentedRoles, AccessLevel? accessLevel = null)

Parameters

teamKey string

consentedRoles string[]

accessLevel AccessLevel?

Returns

Task

SetTeamConsentInternalAsync(string, string[], AccessLevel?)

protected abstract Task SetTeamConsentInternalAsync(string teamKey, string[] consentedRoles, AccessLevel? accessLevel)

Parameters

teamKey string

consentedRoles string[]

accessLevel AccessLevel?

Returns

Task

SetTeamCustomRolesAsync(string, IReadOnlyList<TenantRoleDefinition>)

public Task SetTeamCustomRolesAsync(string teamKey, IReadOnlyList<TenantRoleDefinition> customRoles)

Parameters

teamKey string

customRoles IReadOnlyList<TenantRoleDefinition>

Returns

Task

SetTeamCustomRolesInternalAsync(string, IReadOnlyList<TenantRoleDefinition>)

protected abstract Task SetTeamCustomRolesInternalAsync(string teamKey, IReadOnlyList<TenantRoleDefinition> customRoles)

Parameters

teamKey string

customRoles IReadOnlyList<TenantRoleDefinition>

Returns

Task

SetTeamIconAsync(string, byte[], string)

Sets the team's icon from raw image bytes: stores them via the registered IIconStore, persists the reference on the team, and deletes any previously-stored icon. Requires a registered icon store. Gated by team:manage.

public Task SetTeamIconAsync(string teamKey, byte[] data, string contentType)

Parameters

teamKey string

data byte[]

contentType string

Returns

Task

SetTeamIconReferenceInternalAsync(string, string)

Backs SetTeamIconAsync(string, byte[], string) / ClearTeamIconAsync(string) — persists the icon reference (or null to clear) on the team document. Virtual-throw so existing derived services keep compiling; storage-backed bases override it.

protected virtual Task SetTeamIconReferenceInternalAsync(string teamKey, string reference)

Parameters

teamKey string

reference string

Returns

Task

SetTeamMemberInvitationResponseAsync(string, string, string, bool)

protected abstract Task<ITeam> SetTeamMemberInvitationResponseAsync(string teamKey, string userKey, string inviteKey, bool accept)

Parameters

teamKey string

userKey string

inviteKey string

accept bool

Returns

Task<ITeam>

SetTeamMemberLastSeenAsync(string, string)

protected abstract Task SetTeamMemberLastSeenAsync(string teamKey, string userKey)

Parameters

teamKey string

userKey string

Returns

Task

SetTeamMemberNameAsync(string, string, string)

protected abstract Task SetTeamMemberNameAsync(string teamKey, string userKey, string name)

Parameters

teamKey string

userKey string

name string

Returns

Task

SetTeamMemberRoleAsync(string, string, AccessLevel)

protected abstract Task SetTeamMemberRoleAsync(string teamKey, string userKey, AccessLevel accessLevel)

Parameters

teamKey string

userKey string

accessLevel AccessLevel

Returns

Task

SetTeamMemberScopeOverridesAsync(string, string, string[])

protected abstract Task SetTeamMemberScopeOverridesAsync(string teamKey, string userKey, string[] scopeOverrides)

Parameters

teamKey string

userKey string

scopeOverrides string[]

Returns

Task

SetTeamMemberTenantRolesAsync(string, string, string[])

protected abstract Task SetTeamMemberTenantRolesAsync(string teamKey, string userKey, string[] tenantRoles)

Parameters

teamKey string

userKey string

tenantRoles string[]

Returns

Task

SetTeamNameAsync(string, string)

protected abstract Task SetTeamNameAsync(string teamKey, string name)

Parameters

teamKey string

name string

Returns

Task

TransferOwnershipAsync<TMember>(string, string)

public Task TransferOwnershipAsync<TMember>(string teamKey, string newOwnerUserKey) where TMember : ITeamMember

Parameters

teamKey string

newOwnerUserKey string

Returns

Task

Type Parameters

TMember

Events

SelectTeamEvent

public event EventHandler<SelectTeamEventArgs> SelectTeamEvent

Event Type

EventHandler<SelectTeamEventArgs>

TeamsListChangedEvent

public event EventHandler<TeamsListChangedEventArgs> TeamsListChangedEvent

Event Type

EventHandler<TeamsListChangedEventArgs>