Skip to contents

Delete event subscription

Source: R/delete_event_subscription.R
delete_event_subscription.Rd

Delete event subscription

Usage

delete_event_subscription(subscriptionId, env = "production")

Arguments

subscriptionId

(numeric) Event subscription identifier

env

(character) Repository environment. Can be: "production", "staging", or "development".

Value

(logical) TRUE if the event subscription was deleted

Details

After "deletion", the subscription might still exist in the subscription database, but it will be inactive - it will not conflict with future creation requests, it cannot be read, and it will not be notified of events.

Note

User authentication is required (see login())

See also

Other Event Notifications: create_event_subscription(), execute_event_subscription(), get_event_subscription_schema(), get_event_subscription(), query_event_subscriptions()

Examples

if (FALSE) {

login()

# Create subscription
subscriptionId <- create_event_subscription(
  packageId = "knb-lter-vcr.340.1",
  url = "https://my.webserver.org/",
  env = "staging"
)
subscriptionId
#> [1] 48

# Execute subscription
execute_event_subscription(
  subscriptionId = subscriptionId,
  env = "staging"
)
#> [1] TRUE

# Delete subscription
delete_event_subscription(subscriptionId, env = "staging")
#> [1] TRUE

logout()
}