Class PushNotificationServiceRow
Used for storing handles to user devices that should receive push notifications
Row Object for table 'PushNotificationService'. Row objects correspond directly to database tables, and one
instance of a row object represents one row in the corresponding table in the database.
Inherited Members
Namespace: SuperOfficeCRMRows
Assembly: SoDataBase.dll
Syntax
public class PushNotificationServiceRow : TableRowBase, INestedPersist, ISoDataLookup, ISentryIgnorable
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.TableRowBase.Save method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database.
- You can create a (nested) PushNotificationServiceRow PushNotificationServiceRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.PushNotificationServiceRow.IsNew and SuperOffice.CRM.Data.PushNotificationServiceRow.IsDirty properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
- Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the PushNotificationServiceTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, PushNotificationServiceTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Unique indexes on table PushNotificationService are:
| Index fields | Nested index class name |
|---|
Constructors
PushNotificationServiceRow(PushNotificationServiceRowIdxBase)
Constructor for the class taking an index as argument. Used for storing handles to user devices that should receive push notifications
Declaration
protected PushNotificationServiceRow(PushNotificationServiceRow.PushNotificationServiceRowIdxBase idx)
Parameters
| Type | Name | Description |
|---|---|---|
| PushNotificationServiceRowPushNotificationServiceRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentAssociateId
Current value, see property AssociateId.
Declaration
protected int _currentAssociateId
Field Value
| Type | Description |
|---|---|
| int |
_currentDeviceDisplayName
Current value, see property DeviceDisplayName.
Declaration
protected string _currentDeviceDisplayName
Field Value
| Type | Description |
|---|---|
| string |
_currentDeviceIdentifier
Current value, see property DeviceIdentifier.
Declaration
protected string _currentDeviceIdentifier
Field Value
| Type | Description |
|---|---|
| string |
_currentDevicePlatform
Current value, see property DevicePlatform.
Declaration
protected NotificationPlatform _currentDevicePlatform
Field Value
| Type | Description |
|---|---|
| NotificationPlatform |
_currentLanguage
Current value, see property Language.
Declaration
protected string _currentLanguage
Field Value
| Type | Description |
|---|---|
| string |
_currentLastNotificationDate
Current value, see property LastNotificationDate.
Declaration
protected DateTime _currentLastNotificationDate
Field Value
| Type | Description |
|---|---|
| DateTime |
_currentOSVersion
Current value, see property OSVersion.
Declaration
protected string _currentOSVersion
Field Value
| Type | Description |
|---|---|
| string |
_currentPNSHandle
Current value, see property PNSHandle.
Declaration
protected string _currentPNSHandle
Field Value
| Type | Description |
|---|---|
| string |
_currentPNSHandleUpdateDate
Current value, see property PNSHandleUpdateDate.
Declaration
protected DateTime _currentPNSHandleUpdateDate
Field Value
| Type | Description |
|---|---|
| DateTime |
_currentPocketVersion
Current value, see property PocketVersion.
Declaration
protected string _currentPocketVersion
Field Value
| Type | Description |
|---|---|
| string |
_currentPushNotificationServiceId
Current value, see property PushNotificationServiceId.
Declaration
protected int _currentPushNotificationServiceId
Field Value
| Type | Description |
|---|---|
| int |
_currentRegistered
Current value, see property Registered.
Declaration
protected DateTime _currentRegistered
Field Value
| Type | Description |
|---|---|
| DateTime |
_currentRegisteredAssociateId
Current value, see property RegisteredAssociateId.
Declaration
protected int _currentRegisteredAssociateId
Field Value
| Type | Description |
|---|---|
| int |
_currentTags
Current value, see property Tags.
Declaration
protected string _currentTags
Field Value
| Type | Description |
|---|---|
| string |
_currentTimeZoneId
Current value, see property TimeZoneId.
Declaration
protected int _currentTimeZoneId
Field Value
| Type | Description |
|---|---|
| int |
_currentTotalNotificationCount
Current value, see property TotalNotificationCount.
Declaration
protected int _currentTotalNotificationCount
Field Value
| Type | Description |
|---|---|
| int |
_currentUpdated
Current value, see property Updated.
Declaration
protected DateTime _currentUpdated
Field Value
| Type | Description |
|---|---|
| DateTime |
_currentUpdatedAssociateId
Current value, see property UpdatedAssociateId.
Declaration
protected int _currentUpdatedAssociateId
Field Value
| Type | Description |
|---|---|
| int |
_currentUpdatedCount
Current value, see property UpdatedCount.
Declaration
protected short _currentUpdatedCount
Field Value
| Type | Description |
|---|---|
| short |
_persistedAssociateId
Persisted value, see property AssociateId.
Declaration
protected int _persistedAssociateId
Field Value
| Type | Description |
|---|---|
| int |
_persistedDeviceDisplayName
Persisted value, see property DeviceDisplayName.
Declaration
protected string _persistedDeviceDisplayName
Field Value
| Type | Description |
|---|---|
| string |
_persistedDeviceIdentifier
Persisted value, see property DeviceIdentifier.
Declaration
protected string _persistedDeviceIdentifier
Field Value
| Type | Description |
|---|---|
| string |
_persistedDevicePlatform
Persisted value, see property DevicePlatform.
Declaration
protected NotificationPlatform _persistedDevicePlatform
Field Value
| Type | Description |
|---|---|
| NotificationPlatform |
_persistedLanguage
Persisted value, see property Language.
Declaration
protected string _persistedLanguage
Field Value
| Type | Description |
|---|---|
| string |
_persistedLastNotificationDate
Persisted value, see property LastNotificationDate.
Declaration
protected DateTime _persistedLastNotificationDate
Field Value
| Type | Description |
|---|---|
| DateTime |
_persistedOSVersion
Persisted value, see property OSVersion.
Declaration
protected string _persistedOSVersion
Field Value
| Type | Description |
|---|---|
| string |
_persistedPNSHandle
Persisted value, see property PNSHandle.
Declaration
protected string _persistedPNSHandle
Field Value
| Type | Description |
|---|---|
| string |
_persistedPNSHandleUpdateDate
Persisted value, see property PNSHandleUpdateDate.
Declaration
protected DateTime _persistedPNSHandleUpdateDate
Field Value
| Type | Description |
|---|---|
| DateTime |
_persistedPocketVersion
Persisted value, see property PocketVersion.
Declaration
protected string _persistedPocketVersion
Field Value
| Type | Description |
|---|---|
| string |
_persistedPushNotificationServiceId
Persisted value, see property PushNotificationServiceId.
Declaration
protected int _persistedPushNotificationServiceId
Field Value
| Type | Description |
|---|---|
| int |
_persistedRegistered
Persisted value, see property Registered.
Declaration
protected DateTime _persistedRegistered
Field Value
| Type | Description |
|---|---|
| DateTime |
_persistedRegisteredAssociateId
Persisted value, see property RegisteredAssociateId.
Declaration
protected int _persistedRegisteredAssociateId
Field Value
| Type | Description |
|---|---|
| int |
_persistedTags
Persisted value, see property Tags.
Declaration
protected string _persistedTags
Field Value
| Type | Description |
|---|---|
| string |
_persistedTimeZoneId
Persisted value, see property TimeZoneId.
Declaration
protected int _persistedTimeZoneId
Field Value
| Type | Description |
|---|---|
| int |
_persistedTotalNotificationCount
Persisted value, see property TotalNotificationCount.
Declaration
protected int _persistedTotalNotificationCount
Field Value
| Type | Description |
|---|---|
| int |
_persistedUpdated
Persisted value, see property Updated.
Declaration
protected DateTime _persistedUpdated
Field Value
| Type | Description |
|---|---|
| DateTime |
_persistedUpdatedAssociateId
Persisted value, see property UpdatedAssociateId.
Declaration
protected int _persistedUpdatedAssociateId
Field Value
| Type | Description |
|---|---|
| int |
_persistedUpdatedCount
Persisted value, see property UpdatedCount.
Declaration
protected short _persistedUpdatedCount
Field Value
| Type | Description |
|---|---|
| short |
Properties
AssociateId
.NET type: int. To whom does this handle belong
Declaration
public virtual int AssociateId { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Remarks
Original type in dictionary: FK.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
DeviceDisplayName
.NET type: string. Userfriendly name for device. Ex: 'My iPhone 5S'
Declaration
public virtual string DeviceDisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Remarks
Original type in dictionary: String[257].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
DeviceIdentifier
.NET type: string. Unique device identifier
Declaration
public virtual string DeviceIdentifier { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Remarks
Original type in dictionary: String[257].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
DevicePlatform
.NET type: NotificationPlatform. Device platform. Apple, Google, Microsoft, etc.
Declaration
public virtual NotificationPlatform DevicePlatform { get; set; }
Property Value
| Type | Description |
|---|---|
| NotificationPlatform |
Remarks
Original type in dictionary: Enum.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
InnerFieldValuePairs
The values of all the fields in the row.
The first field is the primary key.
The index of the value corresponds to the name
of the field returned from the Fields property.
Declaration
protected override ArgumentParameterCollection InnerFieldValuePairs { get; }
Property Value
| Type | Description |
|---|---|
| ArgumentParameterCollection |
Overrides
InnerPrimaryKey
The primary key needed to decide which specific row to alter with the current sql-command.
Declaration
protected override FieldInfo InnerPrimaryKey { get; }
Property Value
| Type | Description |
|---|---|
| FieldInfo |
Overrides
InnerPrimaryKeyValue
The actual value the primary key must have.
Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
| Type | Description |
|---|---|
| Parameter |
Overrides
IsDirty
Is the row dirty, e.g. been modified since the last time it was saved to the database.
Declaration
public override bool IsDirty { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Overrides
IsNew
Is this object new, meaning that it does not exist in the database.
Declaration
public override bool IsNew { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Overrides
this[string]
Get or set a value based on the name of the field.
Declaration
public override object this[string fieldName] { get; set; }
Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldName | Name of the field in the database |
Property Value
| Type | Description |
|---|---|
| object | Value of the field. |
Overrides
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if the field is not known. |
Language
.NET type: string. The language to send translated messages in
Declaration
public virtual string Language { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Remarks
Original type in dictionary: String[257].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
LastNotificationDate
.NET type: DateTime. When was a notification last sent to this device
Declaration
public virtual DateTime LastNotificationDate { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime |
Remarks
Original type in dictionary: DateTime.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
OSVersion
.NET type: string. The operating system version this device is using
Declaration
public virtual string OSVersion { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Remarks
Original type in dictionary: String[257].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
PNSHandle
.NET type: string. The platform specific handle needed for pushing messages directly to this device
Declaration
public virtual string PNSHandle { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Remarks
Original type in dictionary: String[1025].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
PNSHandleUpdateDate
.NET type: DateTime. When was the PNSHandle for this device last updated
Declaration
public virtual DateTime PNSHandleUpdateDate { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime |
Remarks
Original type in dictionary: DateTime.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
PocketVersion
.NET type: string. The version of Pocket CRM this device is using
Declaration
public virtual string PocketVersion { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Remarks
Original type in dictionary: String[257].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
PushNotificationServiceId
.NET type: int. Primary key
Declaration
public virtual int PushNotificationServiceId { get; }
Property Value
| Type | Description |
|---|---|
| int |
Remarks
Original type in dictionary: PK.
This field is the primary key and can only be read, never written.
This field is not protected by the Sentry system, and can always be read
PushNotificationServiceTableInfo
Get the PushNotificationServiceTableInfo object associated with the row.
Declaration
public PushNotificationServiceTableInfo PushNotificationServiceTableInfo { get; }
Property Value
| Type | Description |
|---|---|
| PushNotificationServiceTableInfo |
Registered
.NET type: DateTime. Registered when in UTC
Declaration
public virtual DateTime Registered { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime |
Remarks
Original type in dictionary: UtcDateTime.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
RegisteredAssociateId
.NET type: int. Registered by whom
Declaration
public virtual int RegisteredAssociateId { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Remarks
Original type in dictionary: FK.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
TableInfo
Get the TableInfo for the table.
Declaration
public override TableInfo TableInfo { get; }
Property Value
| Type | Description |
|---|---|
| TableInfo | The TableInfo for the table. |
Overrides
Tags
.NET type: string. Comma separated list of notification types this device should or should not receive notifications about. Ex: 'invitations=0,meetings=1
Declaration
public virtual string Tags { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Remarks
Original type in dictionary: String[3073].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
TimeZoneId
.NET type: int. The timezone to show for dates in messages
Declaration
public virtual int TimeZoneId { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Remarks
Original type in dictionary: Int.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
TotalNotificationCount
.NET type: int. How many notifications have been sent to this device
Declaration
public virtual int TotalNotificationCount { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Remarks
Original type in dictionary: Int.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Updated
.NET type: DateTime. Last updated when in UTC
Declaration
public virtual DateTime Updated { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime |
Remarks
Original type in dictionary: UtcDateTime.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
UpdatedAssociateId
.NET type: int. Last updated by whom
Declaration
public virtual int UpdatedAssociateId { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Remarks
Original type in dictionary: FK.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
UpdatedCount
.NET type: short. Number of updates made to this record
Declaration
public virtual short UpdatedCount { get; set; }
Property Value
| Type | Description |
|---|---|
| short |
Remarks
Original type in dictionary: UShort.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Methods
CreateNew()
Create a new instance of the PushNotificationServiceRow object. Used for storing handles to user devices that should receive push notifications
Declaration
public static PushNotificationServiceRow CreateNew()
Returns
| Type | Description |
|---|---|
| PushNotificationServiceRow | A new instance of the PushNotificationServiceRow object. |
GetFromCustomSearch(CustomSearch)
Create a new instance of the PushNotificationServiceRow object, and populate it with data from a custom search. If the search returns no results, an object with IsNew will be returned; if the result contains one row, an object representing that row will be returned. If the result contains more than one row, the first row will be used and the rest discarded (there is no way of detecting this situation).
Declaration
public static PushNotificationServiceRow GetFromCustomSearch(PushNotificationServiceRow.CustomSearch query)
Parameters
| Type | Name | Description |
|---|---|---|
| PushNotificationServiceRowCustomSearch | query | The custom search to execute against the database |
Returns
| Type | Description |
|---|---|
| PushNotificationServiceRow | A new instance of the PushNotificationServiceRow object, reflecting the result of the query. |
GetFromCustomSearchAsync(CustomSearch, CancellationToken)
Create a new instance of the PushNotificationServiceRow object, and populate it with data from a custom search. If the search returns no results, an object with IsNew will be returned; if the result contains one row, an object representing that row will be returned. If the result contains more than one row, the first row will be used and the rest discarded (there is no way of detecting this situation).
Declaration
[CreateSyncVersion(OmitNullableDirective = true)]
public static Task<PushNotificationServiceRow> GetFromCustomSearchAsync(PushNotificationServiceRow.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| PushNotificationServiceRowCustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| TaskPushNotificationServiceRow | A new instance of the PushNotificationServiceRow object, reflecting the result of the query. |
GetFromIdxPushNotificationServiceIdAsync(int, CancellationToken)
Create a new instance of the PushNotificationServiceRow object, by querying the database table via the index 'IDXPushNotificationServiceId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<PushNotificationServiceRow> GetFromIdxPushNotificationServiceIdAsync(int pushNotificationServiceId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | pushNotificationServiceId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| TaskPushNotificationServiceRow | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the PushNotificationService table. Non-unique indexes have corresponding inner classes and methods in the PushNotificationServiceRows collection, since they may return more than one row.
GetFromReader(SoDataReader, PushNotificationServiceTableInfo)
Create a new instance of the PushNotificationServiceRow object, and populate it with data from a reader/tableinfo. If the reader has DBNull as the current value of the primary key field, an unpopulated object with IsNew == true will be returned. If any fields are missing or one of the non-primary key fields is DBNull, an exception will be thrown. Used for storing handles to user devices that should receive push notifications
Declaration
public static PushNotificationServiceRow GetFromReader(SoDataReader reader, PushNotificationServiceTableInfo tableInfo)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| PushNotificationServiceTableInfo | tableInfo | PushNotificationServiceTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object. |
Returns
| Type | Description |
|---|---|
| PushNotificationServiceRow | A new instance of the PushNotificationServiceRow object. |
GetPersistedFieldValue(FieldInfo)
Get the persisted value of a field.
Declaration
public override object GetPersistedFieldValue(FieldInfo field)
Parameters
| Type | Name | Description |
|---|---|---|
| FieldInfo | field | Specification of a field |
Returns
| Type | Description |
|---|---|
| object | Field value, such as an int, DateTime, string ... Null can be returned if the value is not known. |
Overrides
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if the field is not known. |
InternalSetValue(string, object)
Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
| Type | Name | Description |
|---|---|---|
| string | fieldName | |
| object | value |
Overrides
IsPersistedFieldValueKnown(FieldInfo)
Check if the persisted value for a field is known.
Declaration
public override bool IsPersistedFieldValueKnown(FieldInfo field)
Parameters
| Type | Name | Description |
|---|---|---|
| FieldInfo | field | Specification of a field |
Returns
| Type | Description |
|---|---|
| bool | True if the value is known and sentry permits read. |
Overrides
OnLoad(SoDataReader, TableInfo)
Fill the object with data returned from the database.
Declaration
protected override void OnLoad(SoDataReader reader, TableInfo tableInfo)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | Object holding the data returned from the database. |
| TableInfo | tableInfo | The TableInfo used for the SELECT statement. |
Overrides
OnSaveAsync(BatchSave)
Add the object to the BatchSave list if it needs saving.
Declaration
protected override Task OnSaveAsync(BatchSave batchSave)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchSave | batchSave | Collection of objects to be saved within the transaction. |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
Remarks
Classes overriding this method should call it.
OnSavedAsync(bool)
Method called after the save operation has been performed.
Declaration
protected override Task OnSavedAsync(bool bSucceeded)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | bSucceeded | True if the save operation succeeded (e.g. transaction committed), or false if the save operation failed (e.g. transaction rolled back) |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
Reset()
Reset the changes made on the object.
Declaration
protected override void Reset()
Overrides
Remarks
If the row is not persisted to the database (e.g. IsNew is true), all the values will be reset. If the row has been persisted to or loaded from the database, the properties will be set to those of the last persisted or loaded values.
SetDefaultsAsync(DefaulterStrategy, CancellationToken)
Set default values for the row.
Declaration
public override Task SetDefaultsAsync(DefaulterStrategy strategy, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| DefaulterStrategy | strategy | Strategy used when applying default values; values depend on where we are in the Create/Fetch/Populate/Save cycle |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
SetPrimaryKey(int)
Set the primary key for the row.
Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
| Type | Name | Description |
|---|---|---|
| int | primaryKey | The new primary key for the row. |
Overrides
SetRowAsNew()
Declaration
public override void SetRowAsNew()
Overrides
ToString()
ToString method intended for debugging, returns a string that displays the object type, new/dirty status, primary key and the string fields
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string |
Overrides
Validate(RowValidator)
Validate this row.
Declaration
public override void Validate(RowValidator rowValidator)
Parameters
| Type | Name | Description |
|---|---|---|
| RowValidator | rowValidator | RowValidator for inserting the result of the validation |