set_pushover_user: Set, get, and unset the Pushover user/group key

Description Usage Arguments Details Value Examples

View source: R/set_pushover_user.R

Description

set_pushover_user() sets the Pushover user or group key to be used in subsequent commands, get_pushover_user() gets the user or group key that is currently set, and unset_pushover_user() unsets the key.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
set_pushover_user(user = NULL, ask = is_interactive())

get_pushover_user(ask = is_interactive())

unset_pushover_user()

set_pushover_group(user = NULL, ask = is_interactive())

get_pushover_group(ask = is_interactive())

unset_pushover_group()

Arguments

user

The user or group key to be used. If none is provided, a prompt will request the key.

ask

Whether or not to ask for the key if none is provided. Note that this only works for interactive sessions.

Details

set_pushover_group(), get_pushover_group(), and unset_pushover_group() are aliases for these functions.

set_pushover_user() only sets the Pushover user or group for the current session. If a different value is specified in .Renviron, that value will be used in future sessions. Similarly, unset_pushover_user() will only unset the user or group for the current session.

User keys can be found within the settings of the Pushover app or by logging in to https://pushover.net. Group keys can be found after creating a delivery group in your account on https://pushover.net.

Value

get_pushover_user() returns a string containing the current user or group key or an empty string if not set. If the user is not set but ask is TRUE, the user will be prompted for a key.

Examples

1
2
3
4
## Not run: 
set_pushover_user(user = "uQiRzpo4DXghDmr9QzzfQu27cmVRsG")

## End(Not run)

pushoverr documentation built on Nov. 16, 2021, 9:17 a.m.