dmpe/urlshorteneR

View on GitHub
man/bitly_update_bitlink.Rd

Summary

Maintainability
Test Coverage
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bitly_links.R
\name{bitly_update_bitlink}
\alias{bitly_update_bitlink}
\title{Update a Bitlink}
\usage{
bitly_update_bitlink(
  bitlink = NULL,
  archived = NULL,
  tags = NULL,
  showRequestURL = FALSE,
  created_at = NULL,
  title = NULL,
  created_by = NULL,
  long_url = NULL,
  client_id = NULL,
  custom_bitlinks = NULL,
  link = NULL,
  id = NULL,
  deeplinks = list(bitlink = NULL, install_url = NULL, created = NULL, modified = NULL,
    app_uri_path = NULL, install_type = NULL, app_guid = NULL, guid = NULL, os = NULL)
)
}
\arguments{
\item{bitlink}{- required, a Bitlink made of the domain and hash}

\item{archived}{- string | Default: "off" | Enum:"on" "off" "both" | Whether or not to include archived bitlinks}

\item{tags}{- Array of string, use e.g. \code{c("test1", "test2")}}

\item{showRequestURL}{- show URL which has been build and requested from server. For debug
purposes.}

\item{created_at}{- update created at parameter}

\item{title}{- title of the bitlink}

\item{created_by}{- update user}

\item{long_url}{- required, a long URL to be shortened (example: https://www.idnes.cz).
Must contain http/https}

\item{client_id}{- The client ID of an OAuth app}

\item{custom_bitlinks}{- update custom_bitlinks}

\item{link}{- link}

\item{id}{- id}

\item{deeplinks}{- string | Default: "both" | Enum:"on" "off" "both" | Filter to only Bitlinks that contain deeplinks}
}
\description{
See \url{https://dev.bitly.com/api-reference/#updateBitlink}
Update fields in the Bitlink
}
\examples{
\dontrun{
bitly_update_bitlink(bitlink = "bit.ly/DPetrov", title = "novy titulek")

## hash is the one which is only returned. Dont use
bitly_update_bitlink(bitlink = "on.natgeo.com/1bEVhwE")

## manyHashes <- list("bit.ly/DPetrov", "bit.ly/1QU8CFm", "bit.ly/1R1LPSE", "bit.ly/1LNqqva")
## for (u in 1:length(manyHashes)) {
##   print(bitly_update_bitlink(bitlink = manyHashes[[u]],
##                 title = stri_rand_strings(1, 8, pattern = "[A-Za-z0-9]")))
## }
}
}