Fliplet.Content()

(Returns Promise)

The fliplet-content package contains helpers to create and manage content using data sources.

When content is created using Fliplet.Content(), a record is stored in the specified data source. This can be used to aggregate all the content being created via different users, screens and apps.

Contents created with Fliplet.Content() can be used to create features such as:

  • Saving a search configuration
  • Bookmarking a page/directory entry
  • Liking a piece of content with a thumb-up
  • etc.

To build these features, create an instance with Fliplet.Content() and use the returned object in the promise resolving function to call the available methods.

Fliplet.Content(dataSourceId)
  • dataSourceId (Number) The data source ID where the content will be stored.
Fliplet.Content(options)
  • options (Object) A map of options to pass to the constructor.
    • dataSourceId (Number) The data source ID where the content will be stored.
    • user (Object) The user object to be used to identify a specific user. If set, content created will be stored with the provided user object. Query, update and delete actions will only work if the user object matches.

Examples

Share a page with a URL

This example uses the Fliplet.Communicate.shareURL() API to share the URL once it’s generated. This means the fliplet-communicate dependency also needs to be added.

Fliplet.Content({dataSourceId: 2}).then(function (content) {
  content.create({
    pageId: 3
  }, {
    public: true
  }).then(function(entry){
    // entry.data.publicSlug returns a slug that can be used for sharing via a http://apps.fliplet.com/r/ URL
    var url = Fliplet.Env.get('appsUrl') + 'r/' + entry.data.publicSlug;
    // Show UI to share the URL
    Fliplet.Communicate.shareURL(url);
  });
});

Count number of times a directory entry is tagged

Fliplet.Content({dataSourceId: 2}).then(function (content) {
  content.query({
    content: {
      pageId: 3282,
      dataSourceEntryId: 5234,
    }
  }).then(function(rows){
    rows; // returns all the data source entries related to the specified content
  });
});

Methods

.create()

(Returns Promise)

Create a content entry in the data source. The created entry is passed as the first parameter to the promise resolving function.

.create(content [, options ])
  • content (Object) An object containing the created content.
  • options (Object) A map of additional options to pass to the method.
    • settings (Object) Additional settings that are stored against the content. This allows the content entry to store additional attributes specific for the user such as bookmark name etc.
    • action (Object) An action object that will be passed to Fliplet.Navigate.to() when the content is opened via a shared URL. This ensures the user is shown the correct page in an app and in the correct state.
    • public (Boolean) If true, a publicSlug property will be available in the returned entry. (Default: false)

.query()

(Returns Promise)

Query for content entries. The result entries are passed as the first parameter to the promise resolving function.

.query([ options ])
  • options (Object) A map of options to pass to the method.
    • where (Object) A map of WHERE clauses to use for the query.
      • content (Object) An object containing the content to query for. This can use JSON-based queries.
      • settings (Object) An object containing the settings to query for. This can use JSON-based queries.
      • action (Object) An object containing the action to query for. This can use JSON-based queries.
    • exact (Boolean) If true, only entries with exact content matches will be returned. (Default: true)

.update()

(Returns Promise)

Update existing entries with new data.

Notes

  • options.id or options.where must be passed to query for the entries to be updated.
.update(data, options)
  • data (Object) An object containing the new data to be stored, including one or more of the following properties.
    • content (Object) The existing content will be replaced by the provided content with a new hash created.
    • settings (Object) The existing settings will be replaced by the provided settings.
    • action (Object) The existing action will be replaced by the provided action.
  • options (Object) A map of options to pass to the method.
    • id (Number) ID for the data source entry to be updated.
    • where (Object) A map of WHERE clauses to use for the query.
      • content (Object) An object containing the content to query for updating. This can use JSON-based queries.
      • settings (Object) An object containing the settings to query for updating. This can use JSON-based queries.
      • action (Object) An object containing the action to query for updating. This can use JSON-based queries.
    • exact (Boolean) If true, only entries with exact content matches will be updated. (Default: true)
    • public (Boolean) Use this property to turn on/off public visibility of the sharead content

.delete()

(Returns Promise)

Delete existing entries.

.delete(options)
  • options (Object) A map of options to pass to the method.
    • id (Number) ID for the data source entry to be deleted.
    • where (Object) A map of WHERE clauses to use for the query.
      • content (Object) An object containing the content to query for deleting. This can use JSON-based queries.
      • settings (Object) An object containing the settings to query for deleting. This can use JSON-based queries.
      • action (Object) An object containing the action to query for deleting. This can use JSON-based queries.
    • exact (Boolean) If true, only entries with exact content matches will be deleted. (Default: true)

Back to API documentation

This documentation is maintained by Fliplet. Full text search provided by Algolia.