Learn R Programming

periscope2 (version 0.2.4)

load_announcements: load_announcements

Description

Reads and parses application announcements configurations in config/announce.yaml, then display announcements in application header.

Usage

load_announcements(
  announcements_file_path = NULL,
  announcement_location_id = "announceAlert"
)

Value

number of seconds an announcement should be staying in caller application

Arguments

announcements_file_path

The path to announcements configuration file.
Use announcementConfigurationsAddin to generate that file.

announcement_location_id

Announcement target location div id (default = "announceAlert")

Details

If announce.yaml does not exist or contains invalid configurations. Nothing will be displayed. Closing announcements is caller application responsibility

See Also

periscope2:announcementConfigurationsAddin()

Examples

Run this code
    load_announcements(system.file("fw_templ/announce.yaml", package = "periscope2"))

Run the code above in your browser using DataLab