postStatus: Post a status message

View source: R/posts.R

postStatusR Documentation

Post a status message

Description

Post the status of an origin, including a helpful message.

Usage

postStatus(
  origin,
  status,
  message = NULL,
  url = NA_character_,
  link_text = NA_character_
)

Arguments

origin

Name of program that is posting status (character)

status

Typically "OK" or "Error" or "Failure" (character)

message

Useful, descriptive text message for user (optional, character)

url

URL of related app page, if any (optional, character)

link_text

Link text for anchor of related app page, if any (optional, character)

Details

Note that posting a new status will overwrite any existing status.

Value

Nothing

See Also

See readStatus for reading status messages.


pteetor/tutils documentation built on July 5, 2025, 1:27 a.m.