class Contentstack::Client
Attributes
host[R]
region[R]
Public Class Methods
new(api_key, delivery_token, environment, options={})
click to toggle source
Initialize “Contentstack” Client
instance
# File lib/contentstack/client.rb, line 9 def initialize(api_key, delivery_token, environment, options={}) @region = options[:region].nil? ? Contentstack::Region::US : options[:region] @host = options[:host].nil? ? get_default_region_hosts(@region) : options[:host] API.init_api(api_key, delivery_token, environment, @host) end
Public Instance Methods
asset(uid)
click to toggle source
# File lib/contentstack/client.rb, line 27 def asset(uid) Asset.new(uid) end
assets()
click to toggle source
# File lib/contentstack/client.rb, line 23 def assets AssetCollection.new end
content_type(uid)
click to toggle source
# File lib/contentstack/client.rb, line 19 def content_type(uid) ContentType.new({uid: uid}) end
content_types()
click to toggle source
# File lib/contentstack/client.rb, line 15 def content_types ContentType.all end
sync(params)
click to toggle source
Syncs your Contentstack
data with your app and ensures that the data is always up-to-date by providing delta updates
Stack.sync({'init': true}) // For initializing sync Stack.sync({'init': true, 'locale': 'en-us'}) //For initializing sync with entries of a specific locale Stack.sync({'init': true, 'start_date': '2018-10-22'}) //For initializing sync with entries published after a specific date Stack.sync({'init': true, 'content_type_uid': 'session'}) //For initializing sync with entries of a specific content type Stack.sync({'init': true, 'type': 'entry_published'}) // Use the type parameter to get a specific type of content.Supports 'asset_published', 'entry_published', 'asset_unpublished', 'entry_unpublished', 'asset_deleted', 'entry_deleted', 'content_type_deleted'. Stack.sync({'pagination_token': '<btlsomething>'}) // For fetching the next batch of entries using pagination token Stack.sync({'sync_token': '<btlsomething>'}) // For performing subsequent sync after initial sync
@param params [Hash] params is an object that supports ‘locale’, ‘start_date’, ‘content_type_uid’, and ‘type’ queries.
# File lib/contentstack/client.rb, line 49 def sync(params) sync_result = API.get_sync_items(params) SyncResult.new(sync_result) end
Private Instance Methods
get_default_region_hosts(region='us')
click to toggle source
# File lib/contentstack/client.rb, line 55 def get_default_region_hosts(region='us') case region when "us" host = "https://cdn.contentstack.io" when "eu" host = "https://eu-cdn.contentstack.com" end host end