Packages

package common

Common definitions for clients. Many of these common elements are OData related since OData is the microsoft target web api protocol.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. common
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait ClientMethods extends LazyLogger

    Methods common to clients.

    Methods common to clients. Many take alot of parameters in order to allow them to be used in multiple places.

  2. trait ClientOptions extends AnyRef

    OData control parameters such as OData "prefer" headers.

  3. type EntityLogicalName = common.EntityLogicalName.Type
  4. trait EntityLogicalName$Types extends AnyRef
  5. type EntitySetName = common.EntitySetName.Type
  6. trait EntitySetName$Types extends AnyRef
  7. case class Expand(property: String, select: Seq[String] = Nil, filter: Option[String] = None, orderBy: Seq[String] = Nil, top: Option[Int] = None) extends QueryParts with Product with Serializable

    Another crude spec for $expand.

  8. type Id = common.Id.Type
  9. trait Id$Types extends AnyRef
  10. trait Label extends Object

    Typically a Label or Description.

    Typically a Label or Description.

    Annotations
    @RawJSType() @native()
    See also

    https://docs.microsoft.com/en-us/dynamics365/customer-engagement/web-api/label?view=dynamics-ce-odata-9

  11. trait LocalizedLabel extends Object

    Annotations
    @RawJSType() @native()
    See also

    https://docs.microsoft.com/en-us/dynamics365/customer-engagement/web-api/localizedlabel?view=dynamics-ce-odata-9

  12. case class NavProperty(name: String, id: Option[String] = None, cast: Option[String] = None) extends Product with Serializable

    To navigate to child lists.

    To navigate to child lists. id accesses a specific child. Cast may be required e.g. with AttributeMetadata you need Microsoft.Dynamics.CRM.PicklistAttributeMetadata to return the proper set of attributes.

  13. case class OrderBy(name: String, dir: OrderByDir) extends Product with Serializable
  14. sealed trait OrderByDir extends AnyRef
  15. trait QueryParts extends AnyRef
  16. case class QuerySpec(select: Seq[String] = Nil, filter: Option[String] = None, orderBy: Seq[String] = Nil, includeCount: Boolean = false, expand: Seq[Expand] = Nil, top: Option[Int] = None, skip: Option[Int] = None, fetchXml: Option[String] = None, savedQuery: Option[String] = None, userQuery: Option[String] = None, cast: Option[String] = None, properties: Seq[NavProperty] = Nil) extends QueryParts with Product with Serializable

    Very crude query spec.

    Very crude query spec. This still requires knowledge of the REST URL format. Can expand multiple so Option[Expand] should be Seq[Expand]. QuerySpec contains everything you need for generating a URL except! the first navigation property. "cast" applies to that first navigation property when you render it.

  17. final class QuerySpecOps extends AnyVal
  18. trait QuerySpecSyntax extends AnyRef

Value Members

  1. val defaultMappers: Map[String, (String) ⇒ String]
  2. val defaultODataToOmit: Seq[String]
  3. def dropODataFields[O <: Object](obj: O, patterns: Seq[String] = defaultODataToOmit): O

    Remove any attribute that has a @ annotation in its name.

  4. def remapODataFields[O <: Object](obj: O, mappers: Map[String, (String) ⇒ String] = defaultMappers): O

    Remap some CRM and OData response artifacts if found.

    Remap some CRM and OData response artifacts if found. Note that if O is a non-native JS trait, you may want to ensure that you "add" attributes to your trait that match the conventions specified so you can access the attributes directly later. Mapping function is (attribute name) => (mapped attribute name). key for mappers are the odata extensions. Object is mutated directly. Clone prior if you want. This is very expensive so its *not* done by default in many methods.

  5. object Asc extends OrderByDir with Product with Serializable
  6. object Desc extends OrderByDir with Product with Serializable
  7. object EntityLogicalName extends EntityLogicalName$Types
  8. object EntitySetName extends EntitySetName$Types
  9. object Expand extends Serializable
  10. object Id extends Id$Types
  11. object LocalizedHelpers
  12. object NavProperty extends Serializable
  13. object OrderBy extends Serializable
  14. object QueryParts
  15. object QuerySpec extends Serializable
  16. object headers

Inherited from AnyRef

Inherited from Any

Ungrouped