R/Announcement.R

Defines functions showAnnouncements

Documented in showAnnouncements

#
#   shopifyr: An R Interface to the Shopify API
#
#   Copyright (C) 2014 Charlie Friedemann cfriedem @ gmail.com
#   Shopify API (c) 2006-2014 Shopify Inc.
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

#' Announcement Functions
#' 
#' @param current show only non-expired announcements (default \code{TRUE})
#' @return invisibly returns the \code{\link{ShopifyShop}} object to allow for chaining
#' @name Announcements
showAnnouncements <- function(current = TRUE) {
    if (!is.null(shopInfo$announcement)) {
        announcement <- shopInfo$announcement
        if (!current || (Sys.time() < .parseShopifyTimestamp(announcement$expire_at))) {
            # is valid announcement
            cat(gsub("<br />", "", announcement$rendered_body, fixed=TRUE))
        }
    }
    invisible(self)
}

Try the shopifyr package in your browser

Any scripts or data that you put into this service are public.

shopifyr documentation built on May 29, 2017, 3:54 p.m.