Class PretalxService

PretalxService provides access to the Pretalx API and provides methods to convert pretalx resources into deconf ones.

const store: KeyValueStore
const env = { PRETALX_API_TOKEN: string }
const config = {
  eventSlug: string,
  englishKeys: string[],
}

const pretalx = new PretalxService({ store, env, config })

Hierarchy

PretalxService

Index

Constructors

constructor

Methods

findAnswer getDeconfSlots getDeconfSpeakers getDeconfThemes getEvent getIdFromTitle getQuestions getSessionCap getSessionLinks getSlotId getSlug getSpeakers getSubmissions getTags getTalks isUrl makeUnique

Constructors

constructor

new PretalxService(context: Context): PretalxService
Parameters
- context: Context
Returns PretalxService
- Defined in src/pretalx/pretalx-service.ts:76

Methods

findAnswer

findAnswer(questionId: number, responses: PretalxResponse[]): null | string
findAnswer gets the answer to a specific question from an array of responses.
Parameters
- questionId: number
- responses: PretalxResponse[]
Returns null | string
- Defined in src/pretalx/pretalx-service.ts:176

getDeconfSlots

getDeconfSlots(talks: PretalxTalk[]): SessionSlot[]
getDeconfSlots finds the unique slots from a set of pretalx talks
Parameters
- talks: PretalxTalk[]
Returns SessionSlot[]
- Defined in src/pretalx/pretalx-service.ts:246

getDeconfSpeakers

getDeconfSpeakers(speakers: PretalxSpeaker[], affiliationQuestion: number): Speaker[]
getDeconfSpeakers converts pretalx speakers to deconf
Parameters
- speakers: PretalxSpeaker[]
- affiliationQuestion: number
Returns Speaker[]
- Defined in src/pretalx/pretalx-service.ts:268

getDeconfThemes

getDeconfThemes(tags: PretalxTax[]): Theme[]
getDeconfThemes converts pretalx tags to themes
Parameters
- tags: PretalxTax[]
Returns Theme[]
- Defined in src/pretalx/pretalx-service.ts:284

getEvent

getEvent(): CancelableRequest<PretalxEvent>
Fetch the pretalx event

Returns CancelableRequest<PretalxEvent>
- Defined in src/pretalx/pretalx-service.ts:129

getIdFromTitle

getIdFromTitle(localised: null | Localised, fallback: string): string
getIdFromTitle converts a localised text title into a slug
Parameters
- localised: null | Localised
- fallback: string
Returns string
- Defined in src/pretalx/pretalx-service.ts:223

getQuestions

getQuestions(): Promise<PretalxQuestion[]>
Fetch pretalx questions

Returns Promise<PretalxQuestion[]>
- Defined in src/pretalx/pretalx-service.ts:121

getSessionCap

getSessionCap(talk: PretalxTalk, capacityQuestionId: number): null | number
getSessionCap finds the answer to a numeric question and attempts to parse the number as an integer. It returns the number if it is found, or null if not found or not a numeric string.
Parameters
- talk: PretalxTalk
- capacityQuestionId: number
Returns null | number
- Defined in src/pretalx/pretalx-service.ts:326

getSessionLinks

getSessionLinks(talk: PretalxTalk, linksQuestions: number[]): LocalisedLink[]
getSessionLinks generates a set of LocalisedLinks for a session based on the answers to multiple questions
Parameters
- talk: PretalxTalk
- linksQuestions: number[]
Returns LocalisedLink[]
- Defined in src/pretalx/pretalx-service.ts:295

getSlotId

getSlotId(slot?: PretalxSlot): undefined | string
getSlotId generates a unique id for a pretalx slot, it uses undefined to match Session#slot's type
Parameters
- Optional slot: PretalxSlot
Returns undefined | string
- Defined in src/pretalx/pretalx-service.ts:190

getSlug

getSlug(name: string): string
getSlug converts a text string into a URL friendly slug
Parameters
- name: string
Returns string
- Defined in src/pretalx/pretalx-service.ts:232

getSpeakers

getSpeakers(options?: GetSpeakersOptions): Promise<PretalxSpeaker[]>
Fetch pretalx speakers
Parameters
- options: GetSpeakersOptions = {}
Returns Promise<PretalxSpeaker[]>
- Defined in src/pretalx/pretalx-service.ts:153

getSubmissions

getSubmissions(options?: GetSubmissionOptions): Promise<PretalxTalk[]>
Fetch all pretalx submissions
Parameters
- options: GetSubmissionOptions = {}
Returns Promise<PretalxTalk[]>
- Defined in src/pretalx/pretalx-service.ts:134

getTags

getTags(): Promise<PretalxTax[]>
Fetch pretalx tags

Returns Promise<PretalxTax[]>
- Defined in src/pretalx/pretalx-service.ts:164

getTalks

getTalks(): Promise<PretalxTalk[]>
Fetch released pretalx submissions

Deprecated

Returns Promise<PretalxTalk[]>
- Defined in src/pretalx/pretalx-service.ts:145

isUrl

isUrl(input: string): boolean
isUrl determines if a string passed is a URL or not
Parameters
- input: string
Returns boolean
- Defined in src/pretalx/pretalx-service.ts:202

makeUnique

makeUnique(code: string): string
makeUnique takes a possibly duplicated id and makes sure it is unique (within the life of the PretalxService itself)
Parameters
- code: string
Returns string
- Defined in src/pretalx/pretalx-service.ts:215

Class PretalxService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

context: Context

Returns PretalxService

Methods

findAnswer

Parameters

questionId: number

responses: PretalxResponse[]

Returns null | string

getDeconfSlots

Parameters

talks: PretalxTalk[]

Returns SessionSlot[]

getDeconfSpeakers

Parameters

speakers: PretalxSpeaker[]

affiliationQuestion: number

Returns Speaker[]

getDeconfThemes

Parameters

tags: PretalxTax[]

Returns Theme[]

getEvent

Returns CancelableRequest<PretalxEvent>

getIdFromTitle

Parameters

localised: null | Localised

fallback: string

Returns string

getQuestions

Returns Promise<PretalxQuestion[]>

getSessionCap

Parameters

talk: PretalxTalk

capacityQuestionId: number

Returns null | number

getSessionLinks

Parameters

talk: PretalxTalk

linksQuestions: number[]

Returns LocalisedLink[]

getSlotId

Parameters

Optional slot: PretalxSlot

Returns undefined | string

getSlug

Parameters

name: string

Returns string

getSpeakers

Parameters

options: GetSpeakersOptions = {}

Returns Promise<PretalxSpeaker[]>

getSubmissions

Parameters

options: GetSubmissionOptions = {}

Returns Promise<PretalxTalk[]>

getTags

Returns Promise<PretalxTax[]>

getTalks

Deprecated

Returns Promise<PretalxTalk[]>

isUrl

Parameters

input: string

Returns boolean

makeUnique

Parameters

code: string

Returns string

Settings

Member Visibility

Theme

`Optional` slot: PretalxSlot