api_v1

Type Members

1. case class ActionDef(sdid: Option[String], ddid: String, extSubDeviceId: Option[String], ts: Long, name: String, params: String) extends Product with Serializable

   

2. case class ActionRequest(requestsOfData: List[RequestDef] = Empty.list, dataProvided: List[String] = Empty.list) extends Product with Serializable

   

3. case class ActionResponse(actionRequests: List[ActionRequest]) extends Product with Serializable

   

4. final class AuthType extends Enum[AuthType]

   

5. case class ByDid(did: String) extends DeviceSelector with Product with Serializable

   

   To select the DeviceInfos by the ARTIK Cloud Device Id

6. case class ByExtId(extId: String) extends DeviceSelector with Product with Serializable

   

   To select the DeviceInfos by the External Id (eg user id) from the 3rd party

7. case class ByExtSubDeviceId(extSubDeviceId: String) extends DeviceSelector with Product with Serializable

   

   To select the DeviceInfos (parent) by the sub-device's External Id

8. abstract class CloudConnector extends AnyRef

   

9. trait Context extends AnyRef

   

   Data provide from Context are read-only

10. case class Credentials(kind: AuthType, secret: String, token: String, refreshToken: Option[String], tokenType: Option[String], permissions: List[String], expiresAt: Option[Long]) extends Product with Serializable

    

11. class CryptographicHelper extends AnyRef

    

12. trait CustomAuthenticationTask extends AnyRef

    

13. case class CustomCredentials(extId: Option[String], credentials: Credentials) extends CustomAuthenticationTask with Product with Serializable

    

14. case class DeviceInfo(did: String, extId: Option[String], credentials: Credentials, cloudId: String, userData: Option[String] = None) extends Product with Serializable

    

15. sealed trait DeviceSelector extends AnyRef

    

16. case class Event(ts: Long, payload: String, kind: EventType = EventType.data, extSubDeviceId: Option[String] = None, extSubDeviceTypeId: Option[String] = None) extends Task with Product with Serializable

    

17. final class EventType extends Enum[EventType]

    

18. case class Failure(txt: String, cause: Option[Throwable] = None) extends Product with Serializable

    

19. final class HttpMethod extends Enum[HttpMethod]

    

20. case class InputField(name: String, label: String, inputType: String, value: Option[String], help: Option[String], error: Option[String]) extends Product with Serializable

    

21. case class NotificationResponse(thirdPartyNotifications: List[ThirdPartyNotification], responseToCallback: Option[Response] = None) extends Product with Serializable

    

22. class OauthHelper extends AnyRef

    

23. final class Phase extends Enum[Phase]

    

24. case class RequestDef(url: String, method: HttpMethod = HttpMethod.Get, queryParams: Map[String, String] = Empty.map, headers: Map[String, String] = Empty.map, bodyParams: Map[String, String] = Empty.map, contentType: String = "text/plain", content: String = "", signature: Option[SignatureDataForOAuth] = None, delay: Long = 0, passThrough: Map[String, String] = Empty.map) extends Task with CustomAuthenticationTask with WelcomeTask with Product with Serializable

    

25. trait RequestDefTools extends AnyRef

    

26. case class Response(status: Int, contentType: String, content: String, passThrough: Map[String, String] = Empty.map, headers: Map[String, List[String]] = Empty.map) extends Product with Serializable

    

27. case class SignatureDataForOAuth(clientId: String, clientSecret: String, userToken: String, userSecret: String) extends Product with Serializable

    

28. trait Task extends AnyRef

    

29. case class ThirdPartyNotification(selector: DeviceSelector, requestsOfData: List[RequestDef] = Empty.list, dataProvided: List[String] = Empty.list) extends Product with Serializable

    

30. case class UserFormRequest(title: String, fields: List[InputField], help: Option[String], error: Option[String]) extends CustomAuthenticationTask with Product with Serializable

    

31. case class WelcomeMessage(title: String, body: String) extends WelcomeTask with Product with Serializable

    

32. trait WelcomeTask extends AnyRef

    

33. case class ByDeviceId(did: String, cloudId: String) extends DeviceSelector with Product with Serializable

    

    Annotations

    @deprecated

    Deprecated

    replaced by ByDid

34. case class ByExtDid(extDid: String, cloudId: String) extends DeviceSelector with Product with Serializable

    

    Annotations

    @deprecated

    Deprecated

    replaced by ByExtSubDeviceId

35. case class ByExternalId(extId: String, cloudId: String) extends DeviceSelector with Product with Serializable

    

    Annotations

    @deprecated

    Deprecated

    replaced by ByExtId