Packages

case class WebApi(_internal: scala.model.domain.api.WebApi) extends Api[WebApi] with Product with Serializable

Annotations
@JSExportAll()
Linear Supertypes
Serializable, Serializable, Product, Equals, Api[WebApi], NamedDomainElement, DomainElement, CustomizableElement, PlatformSecrets, AmfObjectWrapper, Annotable, ApiFieldSetter[WebApi], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebApi
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Api
  7. NamedDomainElement
  8. DomainElement
  9. CustomizableElement
  10. PlatformSecrets
  11. AmfObjectWrapper
  12. Annotable
  13. ApiFieldSetter
  14. AnyRef
  15. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebApi()
    Annotations
    @JSExportTopLevel( "WebApi" )
  2. new WebApi(_internal: scala.model.domain.api.WebApi)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from WebApi to any2stringadd[WebApi] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WebApi, B)
    Implicit
    This member is added by an implicit conversion from WebApi to ArrowAssoc[WebApi] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def accepts: ClientList[StrField]
    Definition Classes
    Api
  7. def annotations(): Annotations
    Definition Classes
    AmfObjectWrapper → Annotable
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def contentType: ClientList[StrField]
    Definition Classes
    Api
  11. def customDomainProperties: core.internal.convert.CoreClientConverters.ClientList[DomainExtension]
    Definition Classes
    DomainElement → CustomizableElement
  12. def description: StrField
    Definition Classes
    Api
  13. def documentations: ClientList[CreativeWork]
    Definition Classes
    Api
  14. def endPoints: ClientList[EndPoint]
    Definition Classes
    Api
  15. def ensuring(cond: (WebApi) ⇒ Boolean, msg: ⇒ Any): WebApi
    Implicit
    This member is added by an implicit conversion from WebApi to Ensuring[WebApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (WebApi) ⇒ Boolean): WebApi
    Implicit
    This member is added by an implicit conversion from WebApi to Ensuring[WebApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): WebApi
    Implicit
    This member is added by an implicit conversion from WebApi to Ensuring[WebApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): WebApi
    Implicit
    This member is added by an implicit conversion from WebApi to Ensuring[WebApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def extendsNode: core.internal.convert.CoreClientConverters.ClientList[DomainElement]
    Definition Classes
    DomainElement
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WebApi to StringFormat[WebApi] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def graph(): Graph
    Definition Classes
    DomainElement
  25. def id: String
    Definition Classes
    DomainElement
  26. def identifier: StrField
    Definition Classes
    Api
  27. def isExternalLink: BoolField
    Definition Classes
    DomainElement
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def license: License
    Definition Classes
    Api
  30. def name: StrField
    Definition Classes
    Api → NamedDomainElement
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. val platform: Platform
    Definition Classes
    PlatformSecrets
  35. def position: Range
    Definition Classes
    DomainElement
  36. def provider: Organization
    Definition Classes
    Api
  37. def schemes: ClientList[StrField]
    Definition Classes
    Api
  38. def security: ClientList[SecurityRequirement]
    Definition Classes
    Api
  39. def servers: ClientList[Server]
    Definition Classes
    Api
  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def termsOfService: StrField
    Definition Classes
    Api
  42. def version: StrField
    Definition Classes
    Api
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  46. def withAccepts(accepts: ClientList[String]): WebApi.this.type

    Set accepts property of this WebApi.

    Set accepts property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  47. def withContentType(contentType: ClientList[String]): WebApi.this.type

    Set contentType property of this WebApi.

    Set contentType property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  48. def withCustomDomainProperties(extensions: core.internal.convert.CoreClientConverters.ClientList[DomainExtension]): WebApi.this.type
    Definition Classes
    DomainElement → CustomizableElement
  49. def withDefaultServer(url: String): Server

    Adds one Server to the servers property of this WebApi and returns it for population.

    Adds one Server to the servers property of this WebApi and returns it for population. url property of the server is required. This method marks this Server as default. When generating this Server in RAML or OAS2, it will generate a 'baseUri', 'host' or 'basePath', instead of a 'servers' annotation.

    Definition Classes
    Api
  50. def withDescription(description: String): WebApi.this.type
    Definition Classes
    WebApi → ApiFieldSetter
  51. def withDocumentation(documentations: ClientList[CreativeWork]): WebApi.this.type

    Set documentation property of this WebApi using a CreativeWork

    Set documentation property of this WebApi using a CreativeWork

    Definition Classes
    WebApi → ApiFieldSetter
  52. def withDocumentationTitle(title: String): CreativeWork

    Adds one CreativeWork to the documentations property of this WebApi and returns it for population.

    Adds one CreativeWork to the documentations property of this WebApi and returns it for population. Path property of the CreativeWork is required.

    Definition Classes
    Api
  53. def withDocumentationUrl(url: String): CreativeWork

    Adds one CreativeWork to the documentations property of this WebApi and returns it for population.

    Adds one CreativeWork to the documentations property of this WebApi and returns it for population. Path property of the CreativeWork is required.

    Definition Classes
    Api
  54. def withEndPoint(path: String): EndPoint

    Adds one EndPoint to the endPoints property of this WebApi and returns it for population.

    Adds one EndPoint to the endPoints property of this WebApi and returns it for population. Path property of the endPoint is required.

    Definition Classes
    Api
  55. def withEndPoints(endPoints: ClientList[EndPoint]): WebApi.this.type

    Set endPoints property of this WebApi.

    Set endPoints property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  56. def withExtendsNode(extension: core.internal.convert.CoreClientConverters.ClientList[ParametrizedDeclaration]): WebApi.this.type
    Definition Classes
    DomainElement
  57. def withId(id: String): WebApi.this.type
    Definition Classes
    DomainElement
  58. def withIdentifier(identifier: String): WebApi.this.type

    Set identifier property of this WebApi.

    Set identifier property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  59. def withIsExternalLink(isExternalLink: Boolean): DomainElement
    Definition Classes
    DomainElement
  60. def withLicense(license: License): WebApi.this.type

    Set license property of this WebApi using a License

    Set license property of this WebApi using a License

    Definition Classes
    WebApi → ApiFieldSetter
  61. def withName(name: String): WebApi.this.type

    Set name property of this WebApi.

    Set name property of this WebApi.

    Definition Classes
    WebApi → NamedDomainElement
  62. def withProvider(provider: Organization): WebApi.this.type

    Set provider property of this WebApi using a Organization

    Set provider property of this WebApi using a Organization

    Definition Classes
    WebApi → ApiFieldSetter
  63. def withSchemes(schemes: ClientList[String]): WebApi.this.type

    Set schemes property of this WebApi.

    Set schemes property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  64. def withSecurity(security: ClientList[SecurityRequirement]): WebApi.this.type

    Set security property of this WebApi using a list of SecurityRequirement

    Set security property of this WebApi using a list of SecurityRequirement

    Definition Classes
    WebApi → ApiFieldSetter
  65. def withServer(url: String): Server

    Adds one Server to the servers property of this WebApi and returns it for population.

    Adds one Server to the servers property of this WebApi and returns it for population. url property of the server is required.

    Definition Classes
    Api
  66. def withServers(servers: ClientList[Server]): WebApi.this.type

    Set servers property of this WebApi using a list of Server objects.

    Set servers property of this WebApi using a list of Server objects.

    Definition Classes
    WebApi → ApiFieldSetter
  67. def withTermsOfService(terms: String): WebApi.this.type

    Set termsOfService property of this WebApi.

    Set termsOfService property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  68. def withVersion(version: String): WebApi.this.type

    Set version property of this WebApi.

    Set version property of this WebApi.

    Definition Classes
    WebApi → ApiFieldSetter
  69. def →[B](y: B): (WebApi, B)
    Implicit
    This member is added by an implicit conversion from WebApi to ArrowAssoc[WebApi] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Api[WebApi]

Inherited from NamedDomainElement

Inherited from DomainElement

Inherited from CustomizableElement

Inherited from PlatformSecrets

Inherited from AmfObjectWrapper

Inherited from Annotable

Inherited from ApiFieldSetter[WebApi]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from WebApi to any2stringadd[WebApi]

Inherited by implicit conversion StringFormat from WebApi to StringFormat[WebApi]

Inherited by implicit conversion Ensuring from WebApi to Ensuring[WebApi]

Inherited by implicit conversion ArrowAssoc from WebApi to ArrowAssoc[WebApi]

Ungrouped