Streams preview Class

Parameters:

• [options] Object optional

  this object contains function parameters

  • publisherId String

    The publisher's user id.

  • [streamName] String optional

    If empty, and "creatable" is true, then this can be used to add new related streams.

  • [related] Object optional

    , Optional information to add a relation from the newly created stream to another one. Usually set by a "Streams/related" tool. Can include:

    • [publisherId] String optional
      the id of whoever is publishing the related stream
    • [streamName] String optional
      the name of the related stream
    • [type] Mixed optional
      the type of the relation
    • [weight] Number optional
      to override the weight of the relation
  • [editable=true] Boolean | Array optional

    Set to false to avoid showing even authorized users an interface to replace the image or text. Or set to an array naming only certain fields, which the rendering method would hopefully recognize.

  • [closeable=true] Boolean optional

    Set to false to avoid showing even authorized users an option to closeable (or close) this stream

  • [creatable] Object optional

    Optional fields you can override in case if streamName = "",

    • [streamType="Streams/text/small"] String optional
      Set the type of the stream to be created
    • [clickable=true] Boolean optional
      Whether the image composer image is clickable
    • [addIconSize=100] Number optional
      The size in pixels of the square add icon
    • [options={}] Number optional
      Any options to pass to Q.Streams.create
    • [preprocess] Function optional
      This function receives (a callback, this tool, the event if any that triggered it). This is your chance to do any processing before the request to create the stream is sent. The function must call the callback. If you handled creating the stream yourself, pass the stream name as the first parameter, (and optionally the weight of the relation as the second parameter.) If you canceled the process, pass false instead as the first parameter. However, if you want to go ahead and let the preview tool call Q.Streams.create, you can pass here a plain Object with any fields to set for the stream, such as "title", "content", "attributes" (as JSON string), "name", etc.
  • [imagepicker] Object optional

    Any options to pass to the Q/imagepicker jquery plugin -- see its options.

  • [actions] Object optional

    Any options to pass to the Q/actions jquery plugin -- see its options.

  • [sizes] Object optional

    If passed, uses this instead of Q.Streams.image.sizes for the sizes

  • [overrideShowSize] Object optional

    A hash of {icon: size} pairs to override imagepicker.showSize when the icon is a certain string. The empty string matches all icons.

  • [throbber="{{Q}}/img/throbbers/loading.gif"] String optional

    The url of an image to use as an activity indicator when the image is loading

  • [cacheBust=null] Number optional

    Number of milliseconds to use for combating the re-use of cached images when they are first loaded.

  • [beforeCreate] Q.Event optional

    An event that occurs right before a composer requests to create a new stream

  • [onCreate] Q.Event optional

    An event that occurs after a new stream is created by a creatable preview

  • [onComposer] Q.Event optional

    An event that occurs after a composer is rendered. Tools that extend Streams/preview can bind this event to a method to override the contents of the composer.

  • [onRefresh] Q.Event optional

    An event that occurs after a stream preview is rendered for an existing stream. Tools that extend Streams/preview can bind this event to a method to override the contents of the tool.

  • [onLoad] Q.Event optional

    An event that occurs after the refresh calls its callback, which should happen when everything has fully rendered

  • [beforeClose] Q.Event optional

    Optionally set to a function that takes a callback, to display e.g. a dialog box confirming whether to close the stream. It should call the callback with no arguments, in order to proceed with the closing.

  • [onClose] Q.Event optional

    An event that occurs after a stream with a preview has been closed

  • [templates] Object optional

    Under the keys "views", "edit" and "create" you can override options for Q.Template.render . The fields passed to the template include "alt", "titleTag" and "titleClass"

    • [create] Object optional
    • [create.name] String optional
    • [create.fields] Object optional
    • [create.fields.alt] String optional
    • [create.fields.titleClass] String optional
    • [create.fields.titleTag] String optional
• [options.creatable.title="New String

  Item"] Optional title for the case when streamName = "", i.e. the composer