You are reading the documentation for an outdated Corteza release. 2024.9 is the latest stable Corteza release.

Resources and events

Server scripts

Resources and events

compose

Events
On events:
  • on('manual')

  • on('interval')

  • on('timestamp')

Exec arguments
Table 1. Argument properties:
Name Type Mutable

invoker

auth.Identifiable

yes

compose:module

Events
Before/after events:
  • before('create')

  • before('update')

  • before('delete')

  • after('create')

  • after('update')

  • after('delete')

On events:
  • on('manual')

Exec arguments
Table 2. Argument properties:
Name Type Mutable

module

*types.Module

yes

oldModule

*types.Module

no

namespace

*types.Namespace

no

invoker

auth.Identifiable

yes

compose:namespace

Events
Before/after events:
  • before('create')

  • before('update')

  • before('delete')

  • after('create')

  • after('update')

  • after('delete')

On events:
  • on('manual')

Exec arguments
Table 3. Argument properties:
Name Type Mutable

namespace

*types.Namespace

yes

oldNamespace

*types.Namespace

no

invoker

auth.Identifiable

yes

compose:page

Events
Before/after events:
  • before('create')

  • before('update')

  • before('delete')

  • after('create')

  • after('update')

  • after('delete')

On events:
  • on('manual')

Exec arguments
Table 4. Argument properties:
Name Type Mutable

page

*types.Page

yes

oldPage

*types.Page

no

namespace

*types.Namespace

no

selected

[]interface{}

no

invoker

auth.Identifiable

yes

compose:page-layout

Events
Before/after events:
  • before('create')

  • before('update')

  • before('delete')

  • after('create')

  • after('update')

  • after('delete')

On events:
  • on('manual')

Exec arguments
Table 5. Argument properties:
Name Type Mutable

pageLayout

*types.PageLayout

yes

oldPageLayout

*types.PageLayout

no

namespace

*types.Namespace

no

selected

[]interface{}

no

invoker

auth.Identifiable

yes

compose:record

Events
Before/after events:
  • before('create')

  • before('update')

  • before('delete')

  • before('undelete')

  • after('create')

  • after('update')

  • after('delete')

  • after('undelete')

On events:
  • on('manual')

  • on('iteration')

Exec arguments
Table 6. Argument properties:
Name Type Mutable

record

*types.Record

yes

oldRecord

*types.Record

no

module

*types.Module

no

namespace

*types.Namespace

no

recordValueErrors

*types.RecordValueErrorSet

yes

selected

[]interface{}

no

invoker

auth.Identifiable

yes

system

Events
On events:
  • on('manual')

  • on('interval')

  • on('timestamp')

Exec arguments
Table 7. Argument properties:
Name Type Mutable

invoker

auth.Identifiable

yes

system:application

Events
Before/after events:
  • before('create')

  • before('update')

  • before('delete')

  • after('create')

  • after('update')

  • after('delete')

On events:
  • on('manual')

Exec arguments
Table 8. Argument properties:
Name Type Mutable

application

*types.Application

yes

oldApplication

*types.Application

no

invoker

auth.Identifiable

yes

system:auth

Events
Before/after events:
  • before('login')

  • before('signup')

  • after('login')

  • after('signup')

Exec arguments
Table 9. Argument properties:
Name Type Mutable

user

*types.User

yes

provider

*types.AuthProvider

yes

invoker

auth.Identifiable

yes

system:auth-client

Events
Before/after events:
  • before('create')

  • before('update')

  • before('delete')

  • after('create')

  • after('update')

  • after('delete')

On events:
  • on('manual')

Exec arguments
Table 10. Argument properties:
Name Type Mutable

authClient

*types.AuthClient

yes

oldAuthClient

*types.AuthClient

no

invoker

auth.Identifiable

yes

system:data-privacy-request

Events
Before/after events:
  • before('create')

  • before('update')

  • before('delete')

  • after('create')

  • after('update')

  • after('delete')

On events:
  • on('manual')

Exec arguments
Table 11. Argument properties:
Name Type Mutable

dataPrivacyRequest

*types.DataPrivacyRequest

yes

oldDataPrivacyRequest

*types.DataPrivacyRequest

no

invoker

auth.Identifiable

yes

system:mail

Events
On events:
  • on('manual')

  • on('receive')

  • on('send')

Exec arguments
Table 12. Argument properties:
Name Type Mutable

message

*types.MailMessage

yes

invoker

auth.Identifiable

yes

system:queue

Events
On events:
  • on('message')

Exec arguments
Table 13. Argument properties:
Name Type Mutable

payload

*types.QueueMessage

yes

invoker

auth.Identifiable

yes

system:role

Events
Before/after events:
  • before('create')

  • before('update')

  • before('delete')

  • after('create')

  • after('update')

  • after('delete')

On events:
  • on('manual')

Exec arguments
Table 14. Argument properties:
Name Type Mutable

role

*types.Role

yes

oldRole

*types.Role

no

invoker

auth.Identifiable

yes

system:role:member

Events
Before/after events:
  • before('add')

  • before('remove')

  • after('add')

  • after('remove')

Exec arguments
Table 15. Argument properties:
Name Type Mutable

user

*types.User

yes

role

*types.Role

yes

invoker

auth.Identifiable

yes

system:sink

Events
On events:
  • on('request')

Exec arguments
Table 16. Argument properties:
Name Type Mutable

response

*types.SinkResponse

yes

request

*types.SinkRequest

no

invoker

auth.Identifiable

yes

system:user

Events
Before/after events:
  • before('create')

  • before('update')

  • before('delete')

  • before('suspend')

  • after('create')

  • after('update')

  • after('delete')

  • after('suspend')

On events:
  • on('manual')

Exec arguments
Table 17. Argument properties:
Name Type Mutable

user

*types.User

yes

oldUser

*types.User

no

invoker

auth.Identifiable

yes

Client scripts

compose

Events

On events:
  • on('manual')

compose:namespace

On events:
  • on('manual')

compose:module

Events

On events:
  • on('manual')

compose:record

Events

On events:
  • on('manual')

ui:compose:record-page

Events

Before/after events:
  • before('formSubmit')

  • before('delete')

  • after('formSubmit')

  • after('delete')

On events:
  • on('formSubmitError')

ui:compose:admin-record-page

Events

Before/after events:
  • before('formSubmit')

  • before('delete')

  • after('formSubmit')

  • after('delete')

On events:
  • on('formSubmitError')