Session.GetObjectByKeyAsync<ClassType>(Object, CancellationToken) Method
Asynchronously returns a persistent object that has the specified key property value. The persistent object’s type is set by the generic type parameter.
Namespace: DevExpress.Xpo
Assembly: DevExpress.Xpo.v18.2.dll
Declaration
public Task<ClassType> GetObjectByKeyAsync<ClassType>(
object id,
CancellationToken cancellationToken = default(CancellationToken)
)
Parameters
Name | Type | Description |
---|---|---|
id | Object | An object that represents the persistent object’s key property value. |
Optional Parameters
Name | Type | Default | Description |
---|---|---|---|
cancellationToken | CancellationToken | *null* | A CancellationToken object that delivers a cancellation notice to the running operation. |
Type Parameters
Name |
---|
ClassType |
Returns
Type | Description |
---|---|
Task<ClassType> | A Task that returns a persistent object. This persistent object has the specified key property value and a type specified by the generic type parameter. |
Remarks
Below is an example of using the GetObjectByKeyAsync<ClassType> method. Here, the session is the Session instance.
Task<Person> personToDelete = session.GetObjectByKeyAsync<Person>(152);
session.Delete(personToDelete);
The GetObjectByKeyAsync<ClassType> method searches the memory for the object that has the key property value. If such an object is found, it is not reloaded. To get the up-to-date object from the storage, use the overloaded Session.GetObjectByKeyAsync method with the alwaysGetFromDataStore parameter set to true.
Note
The GetObjectByKeyAsync<ClassType> method does not find objects until they are saved to a data store.