diff --git a/.gitignore b/.gitignore index 5048f8506..6aeef717d 100644 --- a/.gitignore +++ b/.gitignore @@ -88,7 +88,7 @@ cypress/videos src/app/models/beast-orm-pro.ts - +doc/TypeDoc src/app/pipes/process.service.spec.ts src/app/pipes/process.service.ts @@ -99,6 +99,8 @@ _src/ -src plugin copy pm2.yaml +doc/TypeDoc/** +doc/TypeDoc # Sentry Config File .sentryclirc diff --git a/doc/TypeDoc/classes/infra_camera_camera_service.CameraService.html b/doc/TypeDoc/classes/infra_camera_camera_service.CameraService.html deleted file mode 100644 index b5c9bbfb6..000000000 --- a/doc/TypeDoc/classes/infra_camera_camera_service.CameraService.html +++ /dev/null @@ -1,9 +0,0 @@ -
Creates an instance of CameraService.
-Takes a picture using the device's camera.
-The parameters for taking the picture.
-A promise that resolves with an ok result containing the file or an err result containing the error.
Service for handling file picking functionality. -This service provides methods to pick a picture from the device's photo library.
-Creates an instance of FilePickerService.
-Picks a picture from the device's photo library.
-The parameters for picking the picture.
-A promise that resolves with an ok result containing the file or an err result containing the error.
Example of a poorly structured startRecording method (commented out).
-Optional$roomOptionalid?: stringOptionaljoinOptionalroomOptionalstatus?: stringOptionaluser?: { OptionaluserOptionalwxOptionalwxOptionalwxeOptionalattachments?: { OptionalcanOptionalmessage?: stringOptionalmessageOptionaloneOptionalrequestOptionalrequireOptionalroomOptionalsenderOptional$id?: numberOptionalattachments?: {}[]OptionalcanOptionalid?: stringOptionalinfo?: {}[]Optionalmessage?: stringOptionalmessageOptionaloneOptionalreactions?: { OptionalrequireOptionalroomOptionalsender?: { OptionaluserOptionalwxOptionalwxOptionalwxeOptionalsending?: booleanOptionalsentOptional$id?: numberOptionalattachments?: {}[]OptionalcanOptionalid?: stringOptionalinfo?: {}[]Optionalmessage?: stringOptionalmessageOptionaloneOptionalreactions?: { OptionalrequireOptionalroomOptionalsender?: { OptionaluserOptionalwxOptionalwxOptionalwxeOptionalsending?: booleanOptionalsentOptionalattachments?: { OptionalcanOptionalmessage?: stringOptionalmessageOptionaloneOptionalrequestOptionalrequireOptionalroomOptionalsenderOptional$id?: numberOptionalattachments?: {}[]OptionalcanOptionalid?: stringOptionalinfo?: {}[]Optionalmessage?: stringOptionalmessageOptionaloneOptionalreactions?: { OptionalrequireOptionalroomOptionalsender?: { OptionaluserOptionalwxOptionalwxOptionalwxeOptionalsending?: booleanOptionalsentOptionalattachments?: { OptionalcanOptionalmessage?: stringOptionalmessageOptionaloneOptionalrequestOptionalrequireOptionalroomOptionalsenderOptionalcreatedOptionalexpirationOptionalmembers?: number[]OptionalroomOptionalroomOptionalroomOptionalroomOptionalroomOptional$roomOptionalid?: stringOptionalisOptionaljoinOptionalroomOptionalstatus?: stringOptionaluserOptionalwxOptionalwxOptionalwxeOptionalcreatedOptionalcreatedOptionaluserOptionalwxOptionalwxOptionalwxeOptionalexpirationOptionalid?: stringOptionalroomOptionalcreatedOptionalcreatedOptionaluserOptionalwxOptionalwxOptionalwxeOptionalexpirationOptionalid?: stringOptionalroomOptional$roomOptionalid?: stringOptionalisOptionaljoinOptionalroomOptionalstatus?: stringOptionaluserOptionalwxOptionalwxOptionalwxeOptionalcreatedOptionalcreatedOptionaluserOptionalwxOptionalwxOptionalwxeOptionalexpirationOptionalid?: stringOptionalroomOptionalchatOptionalentryOptionalid?: stringOptionaluserOptionaluserOptionalchatOptionalentryOptionalid?: stringOptionaluserOptionaluserOptionalcreatedOptionalexpirationOptionalmembers?: number[]OptionalroomOptionalroomOptionalroomOptionalroomOptionalroomOptionalchatOptionalentryOptionalid?: stringOptionaluserOptionaluserStaticfromOptionalattachments?: { OptionalcanOptionalmessage?: stringOptionalmessageOptionaloneOptionalrequestOptionalrequireOptionalroomOptionalsenderStatictoOptionalattachments?: { OptionalcanOptionaldeliverOptionalid?: stringOptionalinfo?: {}[]Optionalmessage?: stringOptionalmessageOptionaloneOptionalreactions?: { OptionalrequestOptionalrequireOptionalroomOptionalsender?: { OptionaluserOptionalwxOptionalwxOptionalwxeOptionalsentOptionalattachments?: { OptionalcanOptionaldeliverOptionalid?: stringOptionalinfo?: {}[]Optionalmessage?: stringOptionalmessageOptionaloneOptionalreactions?: { OptionalrequestOptionalrequireOptionalroomOptionalsender?: { OptionaluserOptionalwxOptionalwxOptionalwxeOptionalsentOptionalattachments?: { OptionalcanOptionaldeliverOptionalid?: stringOptionalinfo?: {}[]Optionalmessage?: stringOptionalmessageOptionaloneOptionalreactions?: { OptionalrequestOptionalrequireOptionalroomOptionalsender?: { OptionaluserOptionalwxOptionalwxOptionalwxeOptionalsentOptionaltracing: TracingTypeOptionalmemberOptionalmessageOptionalreaction?: stringOptionalrequestOptionalroomOptionaldata?: { OptionalcreatedOptionalcreatedOptionalexpirationOptionalid?: stringOptionalroomOptionalroomOptionalmessage?: stringOptionalsuccess?: booleanOptionalchatOptionalentryOptionalid?: stringOptionaluserOptionaluserOptionalchatOptionalentryOptionalid?: stringOptionaluserOptionaluserOptionalid?: stringOptionalisOptionaljoinOptionaluser?: { OptionaluserOptionalwxOptionalwxOptionalwxeCompresses an image represented as a Base64 string.
-This function resizes the image to fit within the specified maximum width and height while maintaining the aspect ratio. -The image is then compressed to a JPEG format with the given quality level.
-The Base64 string of the image to be compressed.
-The maximum width of the compressed image. The aspect ratio is preserved.
-The maximum height of the compressed image. The aspect ratio is preserved.
-The quality of the compressed image, ranging from 0 to 1, where 1 is the best quality.
-A Promise that resolves to a Result containing either:
ok with the compressed image as a Base64 string, orerr with an error if the image fails to load or compress.Parameters for taking a picture.
-ConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConstConst
Service for handling camera functionality. -This service provides methods to interact with the device's camera.
-