[This is preliminary documentation and is subject to change.]
Gets the entity specified by the entityId as a DynamicEntity.
Namespace:
CWR.MSCRM.Mobile.Client.BLAssembly: CWR.MSCRM.Mobile.Client.BL (in CWR.MSCRM.Mobile.Client.BL.dll)
Version: 4.0.0.7
Syntax
| C# |
|---|
public virtual DynamicEntity GetEntity( Guid entityId, ColumnSetBase columns, bool checkOnline, bool onlyIfUpdated ) |
| Visual Basic (Declaration) |
|---|
Public Overridable Function GetEntity ( _ entityId As Guid, _ columns As ColumnSetBase, _ checkOnline As Boolean, _ onlyIfUpdated As Boolean _ ) As DynamicEntity |
Parameters
- entityId
- Type: System..::.Guid
The entity id.
- columns
- Type: ColumnSetBase
The columns to return.
- checkOnline
- Type: System..::.Boolean
if set to true then check online.
- onlyIfUpdated
- Type: System..::.Boolean
if set to true then only return the entity properties if they have been updated.
Return Value
Dictionary of Property containing the entity fields.
Remarks
This method only returns a Property for fields that have a value, so does NOT return properties for NULL values.
Exceptions
| Exception | Condition |
|---|---|
| CWR.MSCRM.Mobile.Client.Helpers.Exceptions..::.CalloutException | Throws a CalloutException when the PreRetrieve(CalloutEntityContext, String%) callout returns Abort. |
