Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • BaseModel
    • default

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns default

Properties

category

category: BelongsTo<typeof default, LucidModel>

specify if the event has a category

categoryId

categoryId: number

the id associated with the category model

coverImgSrc

coverImgSrc: string

Cover image for the event to be displayed

createdAt

createdAt: DateTime

At what date the event was created at

endsAt

endsAt: DateTime

At what date the event ends at

iconImgSrc

iconImgSrc: string

Icon image for the event to be displayed This image can be used for instance as a pinpoint on a map or a more compact view

id

id: number

The id for the event

locationId

locationId: number

The location of the event

longDescription

longDescription: string

The long description of the event. This will not be included by default in the response.

name

name: string

The name of the event

nationId

nationId: number

The nation id the event belongs to

notificationId

notificationId: number

The id related to a notification that is created alongside the event

todo

add this as a serializeAs: null when sure that things work. for now it is present in the response in order to test that notifications are created and such

occursAt

occursAt: DateTime

At what date the event occurs at

onlyMembers

onlyMembers: boolean

specify if the event is only for nation members

onlyStudents

onlyStudents: boolean

specify if the event is only for students

shortDescription

shortDescription: string

The short description of the event

updatedAt

updatedAt: DateTime

At what date the event was updated at

Static afterDate

afterDate: QueryScope<(query: ModelQueryBuilderContract<LucidModel, LucidRow>, date: DateTime) => void> = ...

Filtering options to query events after specified date

Static beforeDate

beforeDate: QueryScope<(query: ModelQueryBuilderContract<LucidModel, LucidRow>, date: DateTime) => void> = ...

Filtering options to query events before specified date

Static filterOutCategories

filterOutCategories: QueryScope<(query: ModelQueryBuilderContract<LucidModel, LucidRow>, categories?: number[]) => void> = ...

filtering options to exclude events for their category that they belong to

param

the number for the id to query for

Static filterOutOids

filterOutOids: QueryScope<(query: ModelQueryBuilderContract<LucidModel, LucidRow>, oids?: number[]) => void> = ...

filtering options to query events for their oid belonging

param

the number for the id to query for

Static forMembers

forMembers: QueryScope<(query: ModelQueryBuilderContract<LucidModel, LucidRow>, value: boolean) => void> = ...

filtering options to query events for members only

param

the boolean for the wether the query is for members or not

Static forStudents

forStudents: QueryScope<(query: ModelQueryBuilderContract<LucidModel, LucidRow>, value: boolean) => void> = ...

filtering options to query events for students only

param

the boolean for the wether the query is for students or not

Static inOrder

inOrder: QueryScope<(query: ModelQueryBuilderContract<LucidModel, LucidRow>) => void> = ...

Ordering options to query events at ascending order

Static onDate

onDate: QueryScope<(query: ModelQueryBuilderContract<LucidModel, LucidRow>, date: DateTime) => void> = ...

Filtering options to query events at specified date

Static perCategory

perCategory: QueryScope<(query: ModelQueryBuilderContract<LucidModel, LucidRow>, categoryId: number) => void> = ...

filtering options to query events for their categoryId

param

the number for the id to query for

Methods

createNotification

  • createNotification(): Promise<void>

Generated using TypeDoc