From 77d80a450d8d2ed9f1365f6a943a85bb42d7e8a8 Mon Sep 17 00:00:00 2001
From: Pedro de Oliveira Guedes <pedro.guedes@digitalcircle.com.br>
Date: Thu, 30 Dec 2021 12:27:20 -0300
Subject: [PATCH] Clip methods improvements.

---
 api/wingui/cli.py | 46 +++++++++++++++++++++++++++++++++++++---------
 1 file changed, 37 insertions(+), 9 deletions(-)

diff --git a/api/wingui/cli.py b/api/wingui/cli.py
index 92cc0f7..e46bf30 100644
--- a/api/wingui/cli.py
+++ b/api/wingui/cli.py
@@ -7,10 +7,11 @@ from typing import List
 import requests
 
 class Wingui:
-    """Classe que representa um proxy para um robo remoto.
-        mapeia o robo através da propriedade rid
-        ep significa endpoint, e aponta para o endereco na web on se hostea o serviço
-        Por padrão é: https://replay.digitalcircle.com.br/robotapi/cmd/
+    """
+    Classe que representa um proxy para um robo remoto.
+    mapeia o robo através da propriedade rid
+    ep significa endpoint, e aponta para o endereco na web on se hostea o serviço
+    Por padrão é: https://localhost:8443
     """
 
     ep: str = ""
@@ -20,7 +21,9 @@ class Wingui:
 
     def __requestget__(self, data: str):
 
-        """Metodo que realiza chamadas http"""
+        """
+        Metodo que realiza requisições HTTP do tipo GET.
+        """
 
         url = self.ep + data
         print("Calling: " + url)
@@ -38,7 +41,9 @@ class Wingui:
     
     def __requestpost__(self, data: str, object: dict):
 
-        """Metodo que realiza chamadas http"""
+        """
+        Metodo que realiza requisições HTTP do tipo POST.
+        """
 
         url = self.ep + data
         print("Calling: " + url)
@@ -56,12 +61,35 @@ class Wingui:
 
 # Funções Clip
     def clip_read(self) -> str:
-        """Le o conteudo da clipboard na maquina do robo, e retorna como string"""
+        """
+        ## Clip Read
+        Le o conteudo da clipboard na maquina do robo, e retorna como string
+
+        ---
+        #### Parâmetros:
+            ---
+        
+        ---
+        #### Retorna:
+            -> Conteúdo da ClipBoard.
+        """
         return self.__requestget__("/ipc/wingui/clip/read")
 
     def clip_write(self, m: str) -> str:
-        """Grava o conteudo fornecido em m na clipboard da maquina robo"""
-        return self.__requestget__("/ipc/wingui/clip/write?str={}".format(urllib.parse.quote(m, "")))
+        """
+        ## Clip Write
+        Grava um texto na ClipBoard da máquina.
+
+        ---
+        #### Parâmetros:
+            - m: Texto que se deseja inserir na ClipBoard
+        ---
+        #### Retorna: 
+
+            ---
+        """
+        str = urllib.parse.quote(m, "")
+        return self.__requestget__(f"/ipc/wingui/clip/write?str={str}")
 
 # Funções Screen
     def screen_click(self, img: str):