← tagasi sisukorda

Suhtlus — avalik kalender

Suhtluse abil saad luua ka avaliku kalendri, mis sisaldab ainult eraldi avalikuks tehtud sündmuseid ning mida saad soovi korral näiteks kooli veebilehele lisada.

Kui oled võimalusest huvitatud, võta Stuudiumi meeskonnaga ühendust Abi kaudu, ja lülitame avaliku kalendri sisse.

Sündmuste avaldamine kalendris toimib nii:

  1. Suhtluses on uus grupp nimega "Avalik"
  2. Sinna saab sündmusi lisada samamoodi, nagu teistesse gruppidesse — vali sündmust lisades adressaadiks "Avalik", ja üritus ilmubki kalendrisse; samuti on võimalik olemasolevale sündmusele lisada osalejaks "Avalik"

    Gruppi "Avalik" saavad üritusi lisada vaid administraatori poolt määratud inimesed

  3. Sündmus ilmub kalendrisse, mis on avalikult (ka sisse logimata kasutajatele) nähtaval aadressil https://koolinimi.ope.ee/kalender

Kalendrile võid veebilehelt viidata lihtsalt lingiga, aga soovi korral saad kalendri ka otse lehele embed-ida.

Meetod 1 (soovitatud)

Lisa see koodijupp kodulehel kohta, kus soovid kalendrit näidata:

<script async src="https://info-koolinimi.ope.ee/calendar.js"></script>

Soovi korral saad muuta ka seda, kui pikka või lühikest ajaperioodi kalender näitab. All olevaid valikuid ei pea määrama, kalender töötab vaikimisi režiimis ka ainult ülal olevat koodirida kasutades.

1: kui lisad aadressile ?weeks=NUMBER parameetri, et kalender näitaks vaikimisi vaate asemel seal määratud arvu nädalaid. Toetatud on väärtused 1—12.

Näiteks, et kuvada kalendrit järgmise 10 nädalaga: <script async src="https://info-koolinimi.ope.ee/calendar.js?weeks=10"></script>

2: et kalender näitaks ~N päeva tulevikku, lisa aadressile parameeter ?days=NUMBER.

Päevade arv ümardatakse automaatselt järgmiseks täisnädalaks. See tähendab, et kui kuvad kalendrit “5 päevaga”, siis:

  • esmaspäeval vaadates kuvab see käesolevat nädalat (esmaspäev kuni reede + ümardus pühapäevani)

  • neljapäeval (ja hiljem) vaadates kuvab kalender käesolevat ja tulevat nädalat (neljapäev kuni esmaspäev + ümardus järgmise pühapäevani)

Näidis: <script async src=“https://info-koolinimi.ope.ee/calendar.js?days=6”></script>

Meetod 2

Lisa see koodijupp kodulehel kohta, kus soovid kalendrit näidata:

<iframe src="https://koolinimi.ope.ee/kalender" frameborder="0" style="border: none; width: 100%; height: 600px;"></iframe>

Kalender toimib hästi ka mobiiltelefonis; kui sinu kooli koduleht pole veel mobiilisõbralik, soovitame kindlasti viidata ka Stuudiumi kalendri-lehele (https://koolinimi.ope.ee/kalender), kuna sellisel juhul võib lehele embeditud kalender mobiilis raskesti loetav olla.

Avalik kalender, näidis


Info arendajatele

Avaliku kalendri sündmusi saab pärida ka JSON formaadis.

Aadressi aluseks on: https://info-koolinimi.ope.ee/api/events

Vajalikud parameetrid:

  • date-start=aaaa-kk-pp (sündmused alates mis kuupäevast)
  • date-end=aaaa-kk-pp (sündmused kuni mis kuupäevani)
  • v=1 (versioon 1, hetkel ainus toetatud väärtus)
  • format=json (vastuse formaat, hetkel on json ainus toetatud väärtus)

date-start ja date-end ajavahemik võib olla kuni 60 päeva.

Lõplikuks aadressiks on näiteks https://info-koolinimi.ope.ee/api/events?v=1&format=json&date-start=2018-09-01&date-end=2018-09-31

Päringu vastus:

Vastusel on päis Access-Control-Allow-Origin: *, mis tähendab, et andmeid saab pärida otse veebilehel oleva Javascript koodiga, tehes AJAX päringu.

JSON array määratud ajavahemikus olevate sündmustega

[
    {
        "title": "Test avalik s\u00fcndmus",
        "body": "- Siin on sisu\n- Teksti kujul\n\n\ud83d\udc4f",
        "event_date": "2018-09-08",
        "event_date_end": "2018-09-09",
        "event_time": "14:00:00",
        "event_time_end": null
    },
    {
        "title": "Teine Test",
        "body": "Siin on veel sisu",
        "event_date": "2018-09-10",
        "event_date_end": null,
        "event_time": null,
        "event_time_end": null
    }
]

Selgitus:

  • title - sündmuse ehk sõnumi pealkiri
  • body - sündmuse ehk sõnumi sisu
  • event_date - sündmuse kuupäev; mitmepäevase sündmuse puhul alguskuupäev
  • event_time - sündmuse alguskellaaeg (võib olla null)
  • event_date_end - sündmuse lõpukuupäev, kui tegu on mitmepäevase sündmusega (võib olla null, kui sündmuse algus- ja lõpukuupäev on samad)
  • event_time_end - sündmuse lõpukellaaeg (võib olla null)
  • Kui sündmusel on algus- ja lõpukuupäev ning algus- ning lõpukellaaeg, tähendab see, et sündmus algab "alguskuupäev + alguskellaaeg" hetkel, ning lõpeb "lõpukuupäev + lõpukellaaeg" hetkel.
  • Kui sündmusel algus- või lõpukellaaega pole (väärtus null), on tegu kogu päeva kestva (või muul põhjusel määramata kellaajaga) sündmusega. Kellaaeg võib aga olla ka näiteks "00:00:00", mis tähistab keskööd.
  • Kuupäevad ja kellaajad on Eesti kohaliku aja järgi.

  • title ja body väljastatakse samal kujul, nagu info kasutaja poolt sisestati. See tähendab, et sisu ei tohi muutmata kujul html lehele väljastada, vaid peab seda eelnevalt turvaliseks töötlema — näiteks asendades < ja > märgid vastavalt &gt; ja &lt;-ga