Class ActivityTrait

The Activity Trait provides logging/storage of user's actions (activities).

Usage:

traits:
  - type: activity
  - events:
    - create
    - update
#  - activityLabel: MyOwnActivity
#  - edgeLabel: hasMyOwnActivity

Hierarchy

Trait<ActivityTraitConfig>
- ActivityTrait

Index

Constructors

constructor

new ActivityTrait(dataSourceWrapper: DataSourceWrapper): ActivityTrait
Parameters
- dataSourceWrapper: DataSourceWrapper
Returns ActivityTrait
Overrides Trait.constructor
- Defined in src/traits/ActivityTrait.ts:53

Properties

`Protected` `Optional` _config

_config?: ActivityTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

Whether this is a global (not bound to any specific schema item) trait instance.

`Protected` `Optional` _type

_type?: "activity"

Trait type.

`Protected` `Readonly` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

Methods

createActivity

createActivity(action: ActivityEventName, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem): Promise<void>
Parameters
- action: ActivityEventName
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
- item: StoredKosmosItem
Returns Promise<void>
- Defined in src/traits/ActivityTrait.ts:125

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<SchemaItemType>): void
Attaches Trait callbacks to schema item hooks.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
Returns void
Overrides Trait.hookIntoSchema
- Defined in src/traits/ActivityTrait.ts:163

hookIntoSchemaManager

hookIntoSchemaManager(): void
Attaches Trait callbacks to schema manager hooks.

Returns void
Inherited from Trait.hookIntoSchemaManager
- Defined in src/traits/Trait.ts:225

makeGlobal

makeGlobal(): ActivityTrait
Makes this Trait instance global.

Returns ActivityTrait
Inherited from Trait.makeGlobal
- Defined in src/traits/Trait.ts:237

name

name(): string
Used to return the name.

Returns string
Inherited from Trait.name
- Defined in src/traits/Trait.ts:198

postCreate

postCreate(...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
This trait function is called once the vertex that the trait was attached to has been successfully created.
Parameters
- Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
Returns Promise<void>
- Defined in src/traits/ActivityTrait.ts:103

postUpdate

postUpdate(...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
This function is call after the entity has been updated.
Parameters
- Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
Returns Promise<void>
- Defined in src/traits/ActivityTrait.ts:118

process

process<RT, Payload>(callbackName: string, datasourceWrapper: DataSourceWrapper, data: TraitDataObject<RT, Payload, Promise<any>>): Promise<RT>
This method is triggered when a trait callback has been activated
Type Parameters
- RT = any
- Payload = any
Parameters
- callbackName: string
  
  This is the name of the callback function to call.
- datasourceWrapper: DataSourceWrapper
  
  References to the Graph Hanlder
- data: TraitDataObject<RT, Payload, Promise<any>>
  
  Request data passed along as part of the request.
Returns Promise<RT>
Inherited from Trait.process
- Defined in src/traits/Trait.ts:147

setConfig

setConfig(config: ActivityTraitConfig): void
ActivityTrait config setter
Parameters
- config: ActivityTraitConfig
  
  This configuration object
Returns void
Overrides Trait.setConfig
- Defined in src/traits/ActivityTrait.ts:65

traitConfig

traitConfig(): ActivityTraitConfig
Returns ActivityTraitConfig
Inherited from Trait.traitConfig
- Defined in src/traits/Trait.ts:205

wrapLegacyResolver

wrapLegacyResolver<RT, Payload>(resolver: LegacyKosmosTraitResolverCallback<RT, any>, datasourceWrapper: DataSourceWrapper, callbackName?: string): KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Helper method for wrapping legacy Kosmos traits callbacks.

TODO: Remove this method once all Traits are converted.
Type Parameters
- RT = any
- Payload = any
Parameters
- resolver: LegacyKosmosTraitResolverCallback<RT, any>
- datasourceWrapper: DataSourceWrapper
- Optional callbackName: string
  
  Optional callback name; passing this parameter will additionally wrap the callback into legacy process().
Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Inherited from Trait.wrapLegacyResolver
- Defined in src/traits/Trait.ts:168

`Static` traitTypeName

traitTypeName(): string
This method should return the trait machine name(s).

Returns

Returns string
Overrides Trait.traitTypeName
- Defined in src/traits/ActivityTrait.ts:92

Class ActivityTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

dataSourceWrapper: DataSourceWrapper

Returns ActivityTrait

Properties

Protected Optional _config

Protected _global

Protected Optional _type

Protected Readonly dataSourceWrapper

Methods

createActivity

Parameters

action: ActivityEventName

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

item: StoredKosmosItem

Returns Promise<void>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns ActivityTrait

name

Returns string

postCreate

Parameters

Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]

Returns Promise<void>

postUpdate

Parameters

Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]

Returns Promise<void>

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<RT, Payload, Promise<any>>

Returns Promise<RT>

setConfig

Parameters

config: ActivityTraitConfig

Returns void

traitConfig

Returns ActivityTraitConfig

wrapLegacyResolver

Type Parameters

RT = any

Payload = any

Parameters

resolver: LegacyKosmosTraitResolverCallback<RT, any>

datasourceWrapper: DataSourceWrapper

Optional callbackName: string

Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>

Static traitTypeName

Returns

Returns string

Settings

Member Visibility

Theme

`Protected` `Optional` _config

`Protected` _global

`Protected` `Optional` _type

`Protected` `Readonly` dataSourceWrapper

`Rest` ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]

`Rest` ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]

`Optional` callbackName: string

`Static` traitTypeName