www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/media_entity_instagram/README.md

   1 ## About Media entity
   2
   3 Media entity provides a 'base' entity for a media element. This is a very basic
   4 entity which can reference to all kinds of media-objects (local files, YouTube
   5 videos, tweets, CDN-files, ...). This entity only provides a relation between
   6 Drupal (because it is an entity) and the resource. You can reference to this
   7 entity within any other Drupal entity.
   8
   9 ## About Media entity Instagram
  10
  11 This module provides Instagram integration for Media entity (i.e. media type provider
  12 plugin).
  13
  14 ### Instagram API
  15 This module uses Instagrams oembed API to fetch the instagram html and all the metadata.
  16 You will need to:
  17
  18 - Create a Media bundle with the type provider "Instagram".
  19 - On that bundle create a field for the Instagram url/source (this should be a plain text or link field).
  20 - Return to the bundle configuration and set "Field with source information" to use that field.
  21
  22 ### Storing field values
  23 If you want to store the fields that are retrieved from Instagram you should create appropriate fields on the created media bundle (id) and map this to the fields provided by Instagram.php.
  24
  25 **NOTE:** At the moment there is no GUI for that, so the only method of doing that for now is via CMI.
  26
  27 This would be an example of that (the field_map section):
  28
  29 ```
  30 langcode: en
  31 status: true
  32 dependencies:
  33   module:
  34     - media_entity_instagram
  35 id: instagram
  36 label: Instagram
  37 description: 'Instagram photo/video to be used with content.'
  38 type: instagram
  39 type_configuration:
  40   source_field: link
  41 field_map:
  42   id: instagram_id
  43   type: instagram_type
  44   thumbnail: instagram_thumbnail
  45   username: instagram_username
  46   caption: instagram_caption
  47 ```
  48
  49 Project page: http://drupal.org/project/media_entity_instagram
  50
  51 Maintainers:
  52  - Janez Urevc (@slashrsm) drupal.org/user/744628
  53  - Malina Randrianavony (@designesse) www.drupal.org/user/854012
  54
  55 IRC channel: #drupal-media