Skip to content

Commit f811d4e

Browse files
djaga-rudjaga-ru
authored
Merge pull request #69 from ZennoLab/dev
docs: add DroidExtra API documentation
2 parents 612ed25 + cb9bc74 commit f811d4e

4 files changed

Lines changed: 530 additions & 1 deletion

File tree

‎docs/ZennoDroid/API/DroidExtra.mdx‎

Lines changed: 254 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,254 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Extra API
4+
title: Extra API | Документация ZennoDroid | ZennoLab
5+
description: Extra API - раздел официальной документации ZennoDroid от ZennoLab. Подробные инструкции, примеры использования и руководство по настройке
6+
---
7+
import DisclaimerNotice from '@site/src/components/DisclaimerNotice';
8+
9+
# Дополнительный API
10+
<DisclaimerNotice />
11+
12+
## Описание.
13+
В данном разделе представлен список интерфейсов не входящих в основной контейнер [DroidInstance API](./DroidInstance), а также имеющие собственные классы для создания объекта.
14+
15+
### Примеры.
16+
```csharp
17+
new DroidManager().ReconnectOffline();
18+
new LSPosedHelper(instance.DroidInstance).Open();
19+
```
20+
_______________________________________________
21+
## Список интерфейсов.
22+
```csharp
23+
IAndroidElementAPI AndroidElementAPI;
24+
IBlueStacks5API BlueStacks5;
25+
IBlueStacks5ManagerAPI BlueStacks5Manager;
26+
IBlueStacks5RootAPI BlueStacks5Root;
27+
IBlueStacks5SettingsAPI BlueStacks5Settings;
28+
IDeviceFilter DeviceFilter;
29+
IDeviceOptions DeviceOptions;
30+
IDeviceSummaryInfo IDeviceSummaryInfo;
31+
IDroidManagerAPI DroidManager;
32+
IDroidProxySettings DroidProxySettings;
33+
IFridaDeviceAPI FridaDevice;
34+
IFridaScriptAPI FridaScriptAPI;
35+
IFridaSessionAPI FridaSessionAPI;
36+
ILSPosedAPI LSPosedHelper;
37+
IQRCodeManager QRCodeManager;
38+
ISqlite3API Sqlite3Helper;
39+
```
40+
## Свойства и методы интерфейсов.
41+
### IAndroidElementAPI
42+
[**`IAndroidElementAPI AndroidElementAPI`**](./Element)
43+
```csharp
44+
string Id { get; }
45+
string Text { get; }
46+
bool IsDisplayed { get; }
47+
Rectangle Rectangle { get; }
48+
string GetAttribute(string name);
49+
bool GetBooleanAttribute(string name);
50+
void Click();
51+
void Clear();
52+
void SendText(string text);
53+
void SendKeys(string text);
54+
string GetScreenshot();
55+
```
56+
### IBlueStacks5API
57+
**`IBlueStacks5API BlueStacks5`**
58+
```csharp
59+
void Start();
60+
void Stop();
61+
void Connect();
62+
void Disconnect();
63+
string AddressPort { get; }
64+
bool IsRunning { get; }
65+
bool IsBootCompleted { get; }
66+
```
67+
### IBlueStacks5ManagerAPI
68+
**`IBlueStacks5ManagerAPI BlueStacks5Manager`**
69+
```csharp
70+
string Create(string imageName, int cpus, int ram, string graphicEngine, string graphicRenderer, string deviceProfile, string abiList);
71+
void DeleteByName(string name);
72+
void StartManager();
73+
void StopManager();
74+
string TitleToNameConverter(string title);
75+
```
76+
### IBlueStacks5RootAPI
77+
**`IBlueStacks5RootAPI BlueStacks5Root`**
78+
```csharp
79+
void Lock();
80+
void Unlock();
81+
void Patch();
82+
void InstallMagisk(string path);
83+
void FlashMagisk();
84+
void EnableZygisk();
85+
```
86+
### IBlueStacks5SettingsAPI
87+
**`IBlueStacks5SettingsAPI BlueStacks5Settings`**
88+
```csharp
89+
void SetGeo(double longitude, double latitude);
90+
void SetIMEI(string value);
91+
```
92+
### IDeviceFilter
93+
[**`IDeviceFilter DeviceFilter`**](./DeviceFilter)
94+
```csharp
95+
string Country { get; set; }
96+
string Manufacturer { get; set; }
97+
string Brand { get; set; }
98+
string Model { get; set; }
99+
string Version { get; set; }
100+
string GpuVendor { get; set; }
101+
```
102+
### IDeviceOptions
103+
[**`IDeviceOptions DeviceOptions`**](./DeviceOptions)
104+
```csharp
105+
bool? AddCanvasNoise { get; set; }
106+
bool? AddGpu { get; set; }
107+
bool? AddWebView { get; set; }
108+
bool? AddWiFiEmulation { get; set; }
109+
```
110+
### IDeviceSummaryInfo
111+
**`IDeviceSummaryInfo IDeviceSummaryInfo`**
112+
```csharp
113+
int Index { get; }
114+
string Name { get; }
115+
string Title { get; }
116+
bool IsRunning { get; }
117+
bool IsBusy { get; }
118+
```
119+
### IDroidManagerAPI
120+
**`IDroidManagerAPI DroidManager`**
121+
```csharp
122+
IDeviceSummaryInfo[] GetListDevices();
123+
int ConvertNameToIndex(string name);
124+
int[] GetListIndices();
125+
string BaseDirectory { get; }
126+
string ConvertIndexToName(int index);
127+
string ConvertIndexToTitle(int index);
128+
string ConvertTitleToName(string title);
129+
string[] GetListNames();
130+
string[] GetListTitles();
131+
void ReconnectOffline();
132+
```
133+
### IDroidProxySettings
134+
**`IDroidProxySettings DroidProxySettings.Proxifier`**
135+
```csharp
136+
bool? BlockWebRtcLeak { get; set; }
137+
bool? BlockUDPLeak { get; set; }
138+
```
139+
**`IDroidProxySettings DroidProxySettings.ProxifierViaPC`**
140+
```csharp
141+
bool? BlockWebRtcLeak { get; set; }
142+
bool? BlockUDPLeak { get; set; }
143+
string DnsServers { get; set; }
144+
string LocalIPv4Address { get; set; }
145+
```
146+
**`IDroidProxySettings DroidProxySettings.Redsocks`**
147+
```csharp
148+
string DnsServers { get; set; }
149+
bool? UseDnsTcp { get; set; }
150+
bool? UseDnsUdp { get; set; }
151+
bool? BlockWebRtcLeak { get; set; }
152+
bool? BlockUDPLeak { get; set; }
153+
string WebRtcLeakAddresses { get; set; }
154+
string WebUdpLeakAddresses { get; set; }
155+
```
156+
**`IDroidProxySettings DroidProxySettings.RedsocksViaPC`**
157+
```csharp
158+
string DnsServers { get; set; }
159+
bool? UseDnsTcp { get; set; }
160+
bool? UseDnsUdp { get; set; }
161+
bool? BlockWebRtcLeak { get; set; }
162+
bool? BlockUDPLeak { get; set; }
163+
string WebRtcLeakAddresses { get; set; }
164+
string WebUdpLeakAddresses { get; set; }
165+
string LocalIPv4Address { get; set; }
166+
```
167+
**`IDroidProxySettings DroidProxySettings.Clash`**
168+
```csharp
169+
string DnsServers { get; set; }
170+
string LocalIPv4Address { get; set; }
171+
string LocalIPv6Address { get; set; }
172+
string WhiteList { get; set; }
173+
string BlackList { get; set; }
174+
string NetworkMode { get; set; }
175+
string Rules { get; set; }
176+
```
177+
**`IDroidProxySettings DroidProxySettings.ClashViaPC`**
178+
```csharp
179+
string DnsServers { get; set; }
180+
string LocalIPv4Address { get; set; }
181+
string LocalIPv6Address { get; set; }
182+
string WhiteList { get; set; }
183+
string BlackList { get; set; }
184+
string NetworkMode { get; set; }
185+
string Rules { get; set; }
186+
```
187+
### IFridaDeviceAPI
188+
**`IFridaDeviceAPI FridaDevice`**
189+
```csharp
190+
string Name { get; }
191+
string Id { get; }
192+
IFridaSessionAPI Attach(uint pid);
193+
uint Spawn(string packageName);
194+
void Resume(uint pid);
195+
void DetachSessionByScriptName(string scriptName);
196+
void DetachAllSessions();
197+
void InstallAndRunServer();
198+
void KillServer();
199+
void LoadScriptToApp(string packageName, string source);
200+
void LoadScriptToFrontmost(string source);
201+
```
202+
### IFridaScriptAPI
203+
**`IFridaScriptAPI FridaScriptAPI`**
204+
```csharp
205+
event EventHandler<FridaScriptMessageEventArgs> Message;
206+
string Name { get; }
207+
void Load();
208+
void Unload();
209+
void Eternalize();
210+
void Post(string message);
211+
void PostWithData(string message, byte[] data);
212+
```
213+
### IFridaSessionAPI
214+
**`IFridaSessionAPI FridaSessionAPI`**
215+
```csharp
216+
uint Pid { get; }
217+
IFridaScriptAPI CreateScript(string source, string name);
218+
IFridaScriptAPI CreateScript(string source);
219+
void Detach();
220+
```
221+
### ILSPosedAPI
222+
**`ILSPosedAPI LSPosedHelper`**
223+
```csharp
224+
string ModuleName { get; set; }
225+
void EnableModule();
226+
void DisableModule();
227+
void AddPackages(params string[] packageNames);
228+
void RemovePackages(params string[] packageNames);
229+
void SetPackages(params string[] packageNames);
230+
void BackupModule(string fileName);
231+
void BackupAllModules(string fileName);
232+
void RestoreModule(string fileName);
233+
void RestoreAllModules(string fileName);
234+
void Open();
235+
void Close();
236+
string GetCLIStatus();
237+
```
238+
### IQRCodeManager
239+
**`IQRCodeManager QRCodeManager`**
240+
```csharp
241+
void CloseQRCodeScanWindow();
242+
void CloseViewfinderWindow();
243+
void DrawImage(byte[] image, Rectangle area, Rectangle background);
244+
void DrawImage(string fileName, Rectangle area, Rectangle background);
245+
void PressQRCodeScanButton();
246+
void SetViewfinderPosition(Rectangle rect);
247+
```
248+
### ISqlite3API
249+
**`ISqlite3API Sqlite3Helper`**
250+
```csharp
251+
void Install();
252+
string ExecuteQuery(string database, string query);
253+
string ExecuteQuery(string database, string query, string options);
254+
```

‎docs/ZennoDroid/API/DroidInstance.mdx‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ IWebViewAPI WebView { get; }
3939
```
4040
## Свойства и методы интерфейсов.
4141
### IAppiumDriverAPI
42-
[**IAppiumDriverAPI AppiumDriver**](./AppiumDriver)
42+
[**`IAppiumDriverAPI AppiumDriver`**](./AppiumDriver)
4343
```csharp
4444
IAndroidElementAPI ActiveElement();
4545
IAndroidElementAPI FindElementByAccessibilityId(string id);
@@ -62,6 +62,9 @@ void UpdateSettings(IEnumerable<KeyValuePair<string, object>> keyValuePairs);
6262
### IDroidActionAPI
6363
[**`IDroidActionAPI Action`**](./Action)
6464
```csharp
65+
void SelectByIndex(int index);
66+
void SelectByName(string name);
67+
void SelectByTitle(string title);
6568
void SelectRandom(string mask);
6669
void SelectRandom(IEnumerable<string> source);
6770
void Start();
@@ -70,6 +73,21 @@ void Start(string captureScreenMethod);
7073
void Start(bool applyProfile, string captureScreenMethod);
7174
void Stop();
7275
```
76+
### IDroidActionEmulatorAPI: IDroidActionAPI
77+
[**`IDroidActionAPI Action`**](./Action)
78+
```csharp
79+
int Clone();
80+
int Create(string version);
81+
int Import(string path);
82+
void DeleteByIndex(int index);
83+
void DeleteByName(string name);
84+
void DeleteByTitle(string title);
85+
void Export(string path);
86+
void FactoryReset(bool resetSystem);
87+
void Rename(int index, string title);
88+
void Rename(string name, string title);
89+
void RenameTo(string title);
90+
```
7391
### IDroidAppAPI
7492
[**`IDroidAppAPI App`**](./Hierarchy)
7593
```csharp

0 commit comments

Comments
 (0)