Class ListItemClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
public class ListItemClient : ClientBase
Constructors
ListItemClient(Contract.IPictureparkServiceSettings, Http.HttpClient)
Declaration
public ListItemClient(Contract.IPictureparkServiceSettings configuration, Http.HttpClient httpClient)
Parameters
Picturepark.SDK.V1.Contract.IPictureparkServiceSettings
configuration
|
System.Net.Http.HttpClient
httpClient
|
Properties
JsonSerializerSettings
Declaration
protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
Newtonsoft.Json.JsonSerializerSettings
|
ReadResponseAsString
Declaration
public bool ReadResponseAsString { get; set; }
Property Value
System.Boolean
|
Methods
AggregateAsync(ListItemAggregationRequest, CancellationToken)
Aggregate list items
Declaration
public virtual async Task<ObjectAggregationResult> AggregateAsync(ListItemAggregationRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemAggregationRequest
request
The list item aggregation request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ObjectAggregationResult>
Object aggregation result |
Remarks
Aggregates list items as specified in the aggregation request.
BatchUpdateFieldsByFilterCoreAsync(ListItemFieldsBatchUpdateFilterRequest, CancellationToken)
Batch update fields - by filter
Declaration
protected virtual async Task<BusinessProcess> BatchUpdateFieldsByFilterCoreAsync(ListItemFieldsBatchUpdateFilterRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemFieldsBatchUpdateFilterRequest
request
List item fields batch update by filter request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Remarks
Updates fields of multiple list items. A filter must be provided to limit the update to specific list items.
The same set of changes is applied to all the list items.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.
BatchUpdateFieldsByIdsCoreAsync(ListItemFieldsBatchUpdateRequest, CancellationToken)
Batch update fields - by IDs
Declaration
protected virtual async Task<BusinessProcess> BatchUpdateFieldsByIdsCoreAsync(ListItemFieldsBatchUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemFieldsBatchUpdateRequest
request
List item fields batch update request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Remarks
Updates fields of multiple list items. A list of list item IDs must be provided to limit the update to specific list items.
The same set of changes is applied to all the list items.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.
CreateAsync(ListItemCreateRequest, IEnumerable<ListItemResolveBehavior>, Nullable<Boolean>, Nullable<TimeSpan>, Nullable<Boolean>, CancellationToken)
Create list item
Declaration
public virtual async Task<ListItemDetail> CreateAsync(ListItemCreateRequest request, IEnumerable<ListItemResolveBehavior> resolveBehaviors = null, bool? allowMissingDependencies = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemCreateRequest
request
List item create request. |
System.Collections.Generic.IEnumerable<ListItemResolveBehavior>
resolveBehaviors
List of enums that control which parts of the list item are resolved and returned. |
System.Nullable<System.Boolean>
allowMissingDependencies
Allows creating list items that refer to list items or contents that don't exist in the system. |
System.Nullable<System.TimeSpan>
timeout
Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
|
System.Nullable<System.Boolean>
waitSearchDocCreation
Wait for the creation of the search document and the rendered display values.
|
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ListItemDetail>
List item detail |
Remarks
Create a new list item.
CreateManyCoreAsync(ListItemCreateManyRequest, CancellationToken)
Create multiple list items
Declaration
protected virtual async Task<BusinessProcess> CreateManyCoreAsync(ListItemCreateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemCreateManyRequest
request
List item create many request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Remarks
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.
DeleteAsync(String, Nullable<Boolean>, Nullable<TimeSpan>, Nullable<Boolean>, CancellationToken)
Delete list item
Declaration
public virtual async Task DeleteAsync(string id, bool? forceReferenceRemoval = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The ID of the list item to delete. |
System.Nullable<System.Boolean>
forceReferenceRemoval
A value indicating whether references to the list item should be removed. |
System.Nullable<System.TimeSpan>
timeout
Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
|
System.Nullable<System.Boolean>
waitSearchDocCreation
Wait for the creation of the search document and the rendered display values.
|
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
Ok |
Remarks
Deletes a list item. The lifecycle is changed to Inactive. After a customer instance specified time (default 30 days), the list item and all related files will be deleted.
DeleteManyAsync(ListItemDeleteManyRequest, CancellationToken)
Delete multiple list items
Declaration
public virtual async Task<BusinessProcess> DeleteManyAsync(ListItemDeleteManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemDeleteManyRequest
request
List item delete many request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Remarks
The lifecycle is changed to Inactive. After a customer instance specified time (default 30 days), the list item and all files will be deleted.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.
DeleteManyByFilterAsync(ListItemDeleteManyFilterRequest, CancellationToken)
Delete multiple list items - by filter
Declaration
public virtual async Task<BusinessProcess> DeleteManyByFilterAsync(ListItemDeleteManyFilterRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemDeleteManyFilterRequest
request
Delete many by filter request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Remarks
Deletes multiple list items. A filter must be provided to limit the deletion to specific list items.
The lifecycle is changed to Inactive. After a customer instance specified time (default 30 days), the list item and all files will be hard deleted.
The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
GetAsync(String, IEnumerable<ListItemResolveBehavior>, CancellationToken)
Get list item
Declaration
public virtual async Task<ListItemDetail> GetAsync(string id, IEnumerable<ListItemResolveBehavior> resolveBehaviors = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The list item ID. |
System.Collections.Generic.IEnumerable<ListItemResolveBehavior>
resolveBehaviors
List of enums that control which parts of the list item are resolved and returned. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ListItemDetail>
List item detail |
Remarks
Gets the list item detail by ID.
GetManyAsync(IEnumerable<String>, IEnumerable<ListItemResolveBehavior>, CancellationToken)
Get multiple list items
Declaration
public virtual async Task<ICollection<ListItemDetail>> GetManyAsync(IEnumerable<string> ids = null, IEnumerable<ListItemResolveBehavior> resolveBehaviors = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
List of list item IDs. |
System.Collections.Generic.IEnumerable<ListItemResolveBehavior>
resolveBehaviors
List of enums that control which parts of the list items are resolved and returned. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<ListItemDetail>>
List of list item details |
Remarks
Gets multiple list item details by IDs.
Can fetch 100 list items at most.
GetReferencesAsync(String, ListItemReferencesRequest, CancellationToken)
Get list item references
Declaration
public virtual async Task<ListItemReferencesResult> GetReferencesAsync(string id, ListItemReferencesRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The ID of the list item. |
ListItemReferencesRequest
request
Request options to specify how many references to fetch. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ListItemReferencesResult>
List item references |
Remarks
Gets the references (list items, contents) to a single list item.
GetReferencesManyAsync(ListItemManyReferencesRequest, CancellationToken)
Get multiple list items references
Declaration
public virtual async Task<ListItemReferencesResult> GetReferencesManyAsync(ListItemManyReferencesRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemManyReferencesRequest
request
ListItemManyReferencesRequest |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ListItemReferencesResult>
A list of references per list item. |
Remarks
Gets the references (list items, contents) to multiple list items.
ReadObjectResponseAsync<T>(Http.HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<ListItemClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(Http.HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
Parameters
System.Net.Http.HttpResponseMessage
response
|
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>>
headers
|
System.Threading.CancellationToken
cancellationToken
|
Returns
System.Threading.Tasks.Task<ListItemClient.ObjectResponseResult<T>>
|
Type Parameters
T
|
RestoreAsync(String, Nullable<Boolean>, Nullable<TimeSpan>, Nullable<Boolean>, CancellationToken)
Restore list item
Declaration
public virtual async Task RestoreAsync(string id, bool? allowMissingDependencies = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The list item ID. |
System.Nullable<System.Boolean>
allowMissingDependencies
Allows restoring list items that refer to list items or contents that don't exist in the system. |
System.Nullable<System.TimeSpan>
timeout
Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
|
System.Nullable<System.Boolean>
waitSearchDocCreation
Wait for the creation of the search document and the rendered display values.
|
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
Ok |
Remarks
Restores a previously deleted list item.
RestoreManyAsync(ListItemRestoreManyRequest, CancellationToken)
Restore multiple list items
Declaration
public virtual async Task<BusinessProcess> RestoreManyAsync(ListItemRestoreManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemRestoreManyRequest
request
List item restore many request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Remarks
Restores previously deleted list items.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.
SearchAsync(ListItemSearchRequest, CancellationToken)
Search list items
Declaration
public virtual async Task<ListItemSearchResult> SearchAsync(ListItemSearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemSearchRequest
request
The list item search request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ListItemSearchResult>
List item search result |
Remarks
Searches list items as specified in the search request.
UpdateCoreAsync(String, ListItemUpdateRequest, IEnumerable<ListItemResolveBehavior>, Nullable<Boolean>, Nullable<TimeSpan>, Nullable<Boolean>, CancellationToken)
Update list item
Declaration
protected virtual async Task<ListItemDetail> UpdateCoreAsync(string id, ListItemUpdateRequest request, IEnumerable<ListItemResolveBehavior> resolveBehaviors = null, bool? allowMissingDependencies = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The list item ID. |
ListItemUpdateRequest
request
The list item update request. |
System.Collections.Generic.IEnumerable<ListItemResolveBehavior>
resolveBehaviors
List of enums that control which parts of the list item are resolved and returned. |
System.Nullable<System.Boolean>
allowMissingDependencies
Allows creating list items that refer to list items or contents that don't exist in the system. |
System.Nullable<System.TimeSpan>
timeout
Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
|
System.Nullable<System.Boolean>
waitSearchDocCreation
Wait for the creation of the search document and the rendered display values.
|
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ListItemDetail>
List item detail |
Remarks
Updates a single list item.
UpdateManyCoreAsync(ListItemUpdateManyRequest, CancellationToken)
Update multiple list items
Declaration
protected virtual async Task<BusinessProcess> UpdateManyCoreAsync(ListItemUpdateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ListItemUpdateManyRequest
request
List item update many request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Remarks
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.