Class PropertyListAdapter

Stub implementation of PropertyListAdapter. Uses in-memory storage for development and testing.

Publishers should extend this class or provide their own implementation that integrates with their property management systems.

Implements

IPropertyListAdapter

Index

Constructors

Methods

isSupported createList updateList getList listLists deleteList isPropertyInList resolveList

Constructors

constructor

new PropertyListAdapter(): PropertyListAdapter
Returns PropertyListAdapter

Methods

isSupported

isSupported(): boolean
Check if property list management is supported. Override this to return true when implementing real logic.

Returns boolean
Implementation of IPropertyListAdapter.isSupported
- Defined in src/lib/adapters/property-list-adapter.ts:125

createList

createList(
request: CreatePropertyListRequest,
): Promise<CreatePropertyListResponse>
Create a new property list
Parameters
- request: CreatePropertyListRequest
Returns Promise<CreatePropertyListResponse>
Implementation of IPropertyListAdapter.createList
- Defined in src/lib/adapters/property-list-adapter.ts:129

updateList

updateList(
request: UpdatePropertyListRequest,
): Promise<UpdatePropertyListResponse>
Update an existing property list
Parameters
- request: UpdatePropertyListRequest
Returns Promise<UpdatePropertyListResponse>
Implementation of IPropertyListAdapter.updateList
- Defined in src/lib/adapters/property-list-adapter.ts:163

getList

getList(request: GetPropertyListRequest): Promise<GetPropertyListResponse>
Get a property list with optional resolution
Parameters
- request: GetPropertyListRequest
Returns Promise<GetPropertyListResponse>
Implementation of IPropertyListAdapter.getList
- Defined in src/lib/adapters/property-list-adapter.ts:192

listLists

listLists(request: ListPropertyListsRequest): Promise<ListPropertyListsResponse>
List all property lists for a principal
Parameters
- request: ListPropertyListsRequest
Returns Promise<ListPropertyListsResponse>
Implementation of IPropertyListAdapter.listLists
- Defined in src/lib/adapters/property-list-adapter.ts:226

deleteList

deleteList(
request: DeletePropertyListRequest,
): Promise<DeletePropertyListResponse>
Delete a property list
Parameters
- request: DeletePropertyListRequest
Returns Promise<DeletePropertyListResponse>
Implementation of IPropertyListAdapter.deleteList
- Defined in src/lib/adapters/property-list-adapter.ts:257

isPropertyInList

isPropertyInList(
    listId: string,
    identifierType: string,
    identifierValue: string,
): Promise<boolean>
Check if a property is in a list. Stub implementation returns false (property not found).
Parameters
- listId: string
- identifierType: string
- identifierValue: string
Returns Promise<boolean>
Implementation of IPropertyListAdapter.isPropertyInList
- Defined in src/lib/adapters/property-list-adapter.ts:282

resolveList

resolveList(
    listId: string,
    maxResults?: number,
    cursor?: string,
): Promise<ResolvedProperty[]>
Resolve a property list to identifiers. Stub implementation returns empty array.
Parameters
- listId: string
- OptionalmaxResults: number
- Optionalcursor: string
Returns Promise<ResolvedProperty[]>
Implementation of IPropertyListAdapter.resolveList
- Defined in src/lib/adapters/property-list-adapter.ts:296