TypeApi: Type operations

Description Format Methods Public fields Methods Examples

Description

LAMP.Type

Format

An R6Class generator object

Methods

getAttachment

getDynamicAttachment

listAttachments

parent Find the owner(s) of the resource. Get the parent type identifier of the data structure referenced by the identifier.

setAttachment

setDynamicAttachment

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods


Method new()

Usage
TypeApi$new(apiClient)

Method getAttachment()

Usage
TypeApi$getAttachment(type.id, attachment.key, ...)

Method getAttachmentWithHttpInfo()

Usage
TypeApi$getAttachmentWithHttpInfo(type.id, attachment.key, ...)

Method getDynamicAttachment()

Usage
TypeApi$getDynamicAttachment(
  type.id,
  attachment.key,
  invoke.always,
  include.logs,
  ignore.output,
  ...
)

Method getDynamicAttachmentWithHttpInfo()

Usage
TypeApi$getDynamicAttachmentWithHttpInfo(
  type.id,
  attachment.key,
  invoke.always,
  include.logs,
  ignore.output,
  ...
)

Method listAttachments()

Usage
TypeApi$listAttachments(type.id, ...)

Method listAttachmentsWithHttpInfo()

Usage
TypeApi$listAttachmentsWithHttpInfo(type.id, ...)

Method parent()

Usage
TypeApi$parent(type.id, transform = NULL, ...)

Method parentWithHttpInfo()

Usage
TypeApi$parentWithHttpInfo(type.id, transform = NULL, ...)

Method setAttachment()

Usage
TypeApi$setAttachment(type.id, target, attachment.key, body, ...)

Method setAttachmentWithHttpInfo()

Usage
TypeApi$setAttachmentWithHttpInfo(type.id, target, attachment.key, body, ...)

Method setDynamicAttachment()

Usage
TypeApi$setDynamicAttachment(
  type.id,
  target,
  attachment.key,
  invoke.once,
  dynamic.attachment,
  ...
)

Method setDynamicAttachmentWithHttpInfo()

Usage
TypeApi$setDynamicAttachmentWithHttpInfo(
  type.id,
  target,
  attachment.key,
  invoke.once,
  dynamic.attachment,
  ...
)

Method clone()

The objects of this class are cloneable with this method.

Usage
TypeApi$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
## Not run: 
####################  getAttachment  ####################

library(LAMP)
var.type.id <- 'type.id_example' # character | 
var.attachment.key <- 'attachment.key_example' # character | 

result <- LAMP.Type$getAttachment(var.type.id, var.attachment.key)


####################  getDynamicAttachment  ####################

library(LAMP)
var.type.id <- 'type.id_example' # character | 
var.attachment.key <- 'attachment.key_example' # character | 
var.invoke.always <- 'invoke.always_example' # character | 
var.include.logs <- 'include.logs_example' # character | 
var.ignore.output <- 'ignore.output_example' # character | 

result <- LAMP.Type$getDynamicAttachment(var.type.id, 
                                        var.attachment.key, 
                                        var.invoke.always, 
                                        var.include.logs, 
                                        var.ignore.output)


####################  listAttachments  ####################

library(LAMP)
var.type.id <- 'type.id_example' # character | 

result <- LAMP.Type$listAttachments(var.type.id)


####################  parent  ####################

library(LAMP)
var.type.id <- 'type.id_example' # character | 

#Find the owner(s) of the resource.
result <- LAMP.Type$parent(var.type.id)


####################  setAttachment  ####################

library(LAMP)
var.type.id <- 'type.id_example' # character | 
var.target <- 'target_example' # character | 
var.attachment.key <- 'attachment.key_example' # character | 
var.body <- NULL # object | 

result <- LAMP.Type$setAttachment(var.type.id, var.target, var.attachment.key, var.body)


####################  setDynamicAttachment  ####################

library(LAMP)
var.type.id <- 'type.id_example' # character | 
var.target <- 'target_example' # character | 
var.attachment.key <- 'attachment.key_example' # character | 
var.invoke.once <- 'invoke.once_example' # character | 
var.dynamic.attachment <- DynamicAttachment$new() # DynamicAttachment | 

result <- LAMP.Type$setDynamicAttachment(var.type.id, 
                                        var.target, 
                                        var.attachment.key, 
                                        var.invoke.once, 
                                        var.dynamic.attachment)



## End(Not run)

BIDMCDigitalPsychiatry/LAMP-r documentation built on April 29, 2020, 9:51 a.m.