Package com.atlassian.webresource.api.assembler

Interface RequiredData

public interface RequiredData
Interface for clients to require data blobs.
Since:
v3.0

  • Method Details

    • requireData

      RequiredData requireData(String key, com.atlassian.json.marshal.Jsonable content)
      Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
      Parameters:
      key - data key
      content - JSON data
      Returns:
      this, to support method chaining WRM.data() JavaScript API

    • requireData

      RequiredData requireData(String key, com.atlassian.json.marshal.Jsonable content, ResourcePhase resourcePhase)

    • requireData

      RequiredData requireData(String key, Number content)
      Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
      Parameters:
      key - data key
      content - content to render
      Returns:
      this, to support method chaining WRM.data() JavaScript API

    • requireData

      RequiredData requireData(String key, Number content, ResourcePhase resourcePhase)

    • requireData

      RequiredData requireData(String key, String content)
      Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
      Parameters:
      key - data key
      content - content to render
      Returns:
      this, to support method chaining WRM.data() JavaScript API

    • requireData

      RequiredData requireData(String key, String content, ResourcePhase resourcePhase)

    • requireData

      RequiredData requireData(String key, Boolean content)
      Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
      Parameters:
      key - data key
      content - content to render
      Returns:
      this, to support method chaining WRM.data() JavaScript API

    • requireData

      RequiredData requireData(String key, Boolean content, ResourcePhase resourcePhase)