election_day.models.notification

Module Contents

Classes

Notification	Stores triggered notifications.
WebhookNotification	Stores triggered notifications.
EmailNotification	Stores triggered notifications.
SmsNotification	Stores triggered notifications.

class election_day.models.notification.Notification

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.TimestampMixin

Stores triggered notifications.

__tablename__ = 'notifications'

type: Column[str]

__mapper_args__

id: Column[uuid.UUID]

last_modified: Column[datetime | None]

election_id: Column[str | None]

election: relationship[Election | None]

election_compound_id: Column[str | None]

election_compound: relationship[ElectionCompound | None]

vote_id: Column[str | None]

vote: relationship[Vote | None]

update_from_model(model: onegov.ballot.models.Election | onegov.ballot.models.ElectionCompound | onegov.ballot.models.Vote) → None

Copy

abstract trigger(request: onegov.election_day.request.ElectionDayRequest, model: onegov.ballot.models.Election | onegov.ballot.models.ElectionCompound | onegov.ballot.models.Vote) → None

Trigger the custom actions.

class election_day.models.notification.WebhookNotification

Bases: Notification

Stores triggered notifications.

__mapper_args__

trigger(request: onegov.election_day.request.ElectionDayRequest, model: onegov.ballot.models.Election | onegov.ballot.models.ElectionCompound | onegov.ballot.models.Vote) → None

Posts the summary of the given vote or election to the webhook URL defined for this principal.

This only works for external URLs. If posting to the server itself is needed, use a process instead of the thread:

process = Process(target=send_post_request, args=(urls, data)) process.start()

class election_day.models.notification.EmailNotification

Bases: Notification

Stores triggered notifications.

__mapper_args__

set_locale(request: onegov.election_day.request.ElectionDayRequest, locale: str | None = None) → None

Changes the locale of the request.

(Re)stores the intial locale if no locale is given.

send_emails(request: onegov.election_day.request.ElectionDayRequest, elections: Sequence[Election], election_compounds: Sequence[ElectionCompound], votes: Sequence[Vote], subject: str | None = None) → None

Sends the results of the vote or election to all subscribers.

Adds unsubscribe headers (RFC 2369, RFC 8058).

trigger(request: onegov.election_day.request.ElectionDayRequest, model: onegov.ballot.models.Election | onegov.ballot.models.ElectionCompound | onegov.ballot.models.Vote) → None

Sends the results of the vote, election or election compound to all subscribers.

Adds unsubscribe headers (RFC 2369, RFC 8058).

class election_day.models.notification.SmsNotification

Bases: Notification

Stores triggered notifications.

__mapper_args__

send_sms(request: onegov.election_day.request.ElectionDayRequest, elections: Sequence[Election], election_compounds: Sequence[ElectionCompound], votes: Sequence[Vote], content: translationstring.TranslationString) → None

Sends the given text to all subscribers.

trigger(request: onegov.election_day.request.ElectionDayRequest, model: onegov.ballot.models.Election | onegov.ballot.models.ElectionCompound | onegov.ballot.models.Vote) → None

Posts a link to the vote or election to all subscribers.

This is done by writing files to a directory similary to maildir, sending the SMS is done using an external command, probably called by a cronjob.