Class ListManagementService

constructor

• new ListManagementService(): ListManagementService

  Returns ListManagementService

Loading$

loading$

• get loading$(): Observable<boolean>

  Returns Observable<boolean>

  Deprecated

  Use Loading$.

• set loading$(value: Observable<boolean>): void

  Parameters

  • value: Observable<boolean>

  Returns void

  Deprecated

  Use Loading$.

Provider

• get Provider(): IMetadataProvider

  Returns IMetadataProvider

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

  Parameters

  • value: IMetadataProvider | null

  Returns void

addRecordsToLists

• addRecordsToLists(
      listIds: string[],
      recordIds: string[],
      skipDuplicates?: boolean,
  ): Promise<BatchOperationResult>

  Parameters

  • listIds: string[]
  • recordIds: string[]
  • skipDuplicates: boolean = true

  Returns Promise<BatchOperationResult>

  Deprecated

  Use AddRecordsToLists.

AddRecordsToLists

• AddRecordsToLists(
      listIds: string[],
      recordIds: string[],
      skipDuplicates?: boolean,
  ): Promise<BatchOperationResult>

  Add records to one or more lists

  Parameters

  • listIds: string[]
  • recordIds: string[]
  • skipDuplicates: boolean = true

  Returns Promise<BatchOperationResult>

buildListViewModels

• buildListViewModels(
      lists: MJListEntity[],
      recordIds: string[],
      membership: Map<string, string[]>,
  ): Promise<ListItemViewModel[]>

  Parameters

  • lists: MJListEntity[]
  • recordIds: string[]
  • membership: Map<string, string[]>

  Returns Promise<ListItemViewModel[]>

  Deprecated

  Use BuildListViewModels.

BuildListViewModels

• BuildListViewModels(
      lists: MJListEntity[],
      recordIds: string[],
      membership: Map<string, string[]>,
  ): Promise<ListItemViewModel[]>

  Build view models for lists with membership information

  Parameters

  • lists: MJListEntity[]
  • recordIds: string[]
  • membership: Map<string, string[]>

  Returns Promise<ListItemViewModel[]>

createList

• createList(config: CreateListConfig): Promise<MJListEntity | null>

  Parameters

  • config: CreateListConfig

  Returns Promise<MJListEntity | null>

  Deprecated

  Use CreateList.

CreateList

• CreateList(config: CreateListConfig): Promise<MJListEntity | null>

  Create a new list

  Parameters

  • config: CreateListConfig

  Returns Promise<MJListEntity | null>

getListCategories

• getListCategories(forceRefresh?: boolean): Promise<MJListCategoryEntity[]>

  Parameters

  • forceRefresh: boolean = false

  Returns Promise<MJListCategoryEntity[]>

  Deprecated

  Use GetListCategories.

GetListCategories

• GetListCategories(forceRefresh?: boolean): Promise<MJListCategoryEntity[]>

  Get all list categories

  Parameters

  • forceRefresh: boolean = false

  Returns Promise<MJListCategoryEntity[]>

getListItemCount

• getListItemCount(listId: string): Promise<number>

  Parameters

  • listId: string

  Returns Promise<number>

  Deprecated

  Use GetListItemCount.

GetListItemCount

• GetListItemCount(listId: string): Promise<number>

  Get item count for a list

  Parameters

  • listId: string

  Returns Promise<number>

getListsForEntity

• getListsForEntity(
      entityId: string,
      userId?: string,
      forceRefresh?: boolean,
  ): Promise<MJListEntity[]>

  Parameters

  • entityId: string
  • OptionaluserId: string
  • forceRefresh: boolean = false

  Returns Promise<MJListEntity[]>

  Deprecated

  Use GetListsForEntity.

GetListsForEntity

• GetListsForEntity(
      entityId: string,
      userId?: string,
      forceRefresh?: boolean,
  ): Promise<MJListEntity[]>

  Get lists for a specific entity, with optional caching

  Parameters

  • entityId: string
  • OptionaluserId: string
  • forceRefresh: boolean = false

  Returns Promise<MJListEntity[]>

getListsForRecord

• getListsForRecord(entityId: string, recordId: string): Promise<MJListEntity[]>

  Parameters

  • entityId: string
  • recordId: string

  Returns Promise<MJListEntity[]>

  Deprecated

  Use GetListsForRecord.

GetListsForRecord

• GetListsForRecord(entityId: string, recordId: string): Promise<MJListEntity[]>

  Get lists that contain a specific record

  Parameters

  • entityId: string
  • recordId: string

  Returns Promise<MJListEntity[]>

getRecordMembership

• getRecordMembership(
      entityId: string,
      recordIds: string[],
  ): Promise<Map<string, string[]>>

  Parameters

  • entityId: string
  • recordIds: string[]

  Returns Promise<Map<string, string[]>>

  Deprecated

  Use GetRecordMembership.

GetRecordMembership

• GetRecordMembership(
      entityId: string,
      recordIds: string[],
  ): Promise<Map<string, string[]>>

  Get membership information for a set of records Returns a Map where key is listId and value is array of recordIds that are members

  Parameters

  • entityId: string
  • recordIds: string[]

  Returns Promise<Map<string, string[]>>

invalidateCache

• invalidateCache(entityId?: string): void

  Parameters

  • OptionalentityId: string

  Returns void

  Deprecated

  Use InvalidateCache.

InvalidateCache

• InvalidateCache(entityId?: string): void

  Invalidate cache for a specific entity or all caches

  Parameters

  • OptionalentityId: string

  Returns void

removeRecordsFromLists

• removeRecordsFromLists(
      listIds: string[],
      recordIds: string[],
  ): Promise<BatchOperationResult>

  Parameters

  • listIds: string[]
  • recordIds: string[]

  Returns Promise<BatchOperationResult>

  Deprecated

  Use RemoveRecordsFromLists.

RemoveRecordsFromLists

• RemoveRecordsFromLists(
      listIds: string[],
      recordIds: string[],
  ): Promise<BatchOperationResult>

  Remove records from one or more lists

  Parameters

  • listIds: string[]
  • recordIds: string[]

  Returns Promise<BatchOperationResult>