Class ListSharingService

constructor

• new ListSharingService(): ListSharingService

  Returns ListSharingService

loading$

Provider

• get Provider(): IMetadataProvider

  Returns IMetadataProvider

• set Provider(value: IMetadataProvider | null): void

  Parameters

  • value: IMetadataProvider | null

  Returns void

canUserShareList

• canUserShareList(listId: string, userId: string): Promise<boolean>

  Check if user can share a list (must be owner or have Owner permission)

  Parameters

  • listId: string
  • userId: string

  Returns Promise<boolean>

clearCache

• clearCache(): void

  Clear internal caches

  Returns void

getAllRoles

• getAllRoles(forceRefresh?: boolean): Promise<MJRoleEntity[]>

  Get all available roles (cached)

  Parameters

  • forceRefresh: boolean = false

  Returns Promise<MJRoleEntity[]>

getAllUsers

• getAllUsers(forceRefresh?: boolean): Promise<MJUserEntity[]>

  Get all available users (cached)

  Parameters

  • forceRefresh: boolean = false

  Returns Promise<MJUserEntity[]>

getListShares

• getListShares(listId: string): Promise<ListShareInfo[]>

  Get all shares for a specific list

  Parameters

  • listId: string

  Returns Promise<ListShareInfo[]>

getListSharingSummary

• getListSharingSummary(
      listId: string,
  ): Promise<
      {
          isSharedByMe: boolean;
          isSharedWithMe: boolean;
          listId: string;
          roleShares: number;
          totalShares: number;
          userShares: number;
      },
  >

  Get sharing summary for a single list

  Parameters

  • listId: string

  Returns Promise<
      {
          isSharedByMe: boolean;
          isSharedWithMe: boolean;
          listId: string;
          roleShares: number;
          totalShares: number;
          userShares: number;
      },
  >

getListsSharedByUser

• getListsSharedByUser(userId: string): Promise<Map<string, number>>

  Get lists that the user has shared with others

  Parameters

  • userId: string

  Returns Promise<Map<string, number>>

getListsSharedWithUser

• getListsSharedWithUser(userId: string): Promise<string[]>

  Get lists shared with the current user (that they don't own)

  Parameters

  • userId: string

  Returns Promise<string[]>

getUserPermissionLevel

• getUserPermissionLevel(
      listId: string,
      userId: string,
  ): Promise<ListPermissionLevel | null>

  Get permission level for a specific user on a specific list

  Parameters

  • listId: string
  • userId: string

  Returns Promise<ListPermissionLevel | null>

removeShare

• removeShare(shareId: string): Promise<ListShareResult>

  Remove a share (revoke access)

  Parameters

  • shareId: string

  Returns Promise<ListShareResult>

searchRoles

• searchRoles(searchTerm: string, limit?: number): Promise<ShareRecipient[]>

  Search roles for sharing autocomplete

  Parameters

  • searchTerm: string
  • limit: number = 10

  Returns Promise<ShareRecipient[]>

searchUsers

• searchUsers(searchTerm: string, limit?: number): Promise<ShareRecipient[]>

  Search users for sharing autocomplete

  Parameters

  • searchTerm: string
  • limit: number = 10

  Returns Promise<ShareRecipient[]>

shareListWithRole

• shareListWithRole(
      listId: string,
      roleId: string,
      permissionLevel: ListPermissionLevel,
      sharedByUserId: string,
  ): Promise<ListShareResult>

  Share a list with a role

  Parameters

  • listId: string
  • roleId: string
  • permissionLevel: ListPermissionLevel
  • sharedByUserId: string

  Returns Promise<ListShareResult>

shareListWithUser

• shareListWithUser(
      listId: string,
      userId: string,
      permissionLevel: ListPermissionLevel,
      sharedByUserId: string,
  ): Promise<ListShareResult>

  Share a list with a user

  Parameters

  • listId: string
  • userId: string
  • permissionLevel: ListPermissionLevel
  • sharedByUserId: string

  Returns Promise<ListShareResult>

updateSharePermission

• updateSharePermission(
      shareId: string,
      newPermissionLevel: ListPermissionLevel,
  ): Promise<ListShareResult>

  Update permission level for an existing share

  Parameters

  • shareId: string
  • newPermissionLevel: ListPermissionLevel

  Returns Promise<ListShareResult>