forked from rpetrich/fonemonkey4
-
Notifications
You must be signed in to change notification settings - Fork 0
/
FoneMonkeyAPI.h
71 lines (59 loc) · 2.64 KB
/
FoneMonkeyAPI.h
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
/* This file is part of FoneMonkey.
FoneMonkey is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
FoneMonkey is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with FoneMonkey. If not, see <http://www.gnu.org/licenses/>. */
//
// FoneMonkeyAPI.h
// FoneMonkey
//
// Created by Stuart Stern on 2/6/10.
// Copyright (c) 2010 Gorilla Logic, Inc. All rights reserved.
//
/** \mainpage FoneMonkey API Documentation
* <div style="border:1px solid black; font-size:12pt;width:50%; margin:5%;padding:5%;text-align:center">
* <div stle="margin-below:24pt"><div>FoneMonkey was created and donated to the iPhone community by Gorilla Logic, an enterprise application consulting firm</div> specializing in iPhone, Flex, and Java.</div>
* To to learn more about our development, training, and testing services at http://www.gorillalogic.com.
* </div>
*/
#import "TouchSynthesis.h"
#import "FMCommandEvent.h"
#import "UIView+FMReady.h"
#import "UIControl+FMready.h"
/** The public API for the FoneMonkey framework.
*/
@interface FoneMonkeyAPI : NSObject
/** Appends the command to the end of the currently recording script.
@param sender the component for which this command is to be recorded
@param command the name of the command.
@param args an array of the command's arguments
*/
+ (void) record:(UIView*)sender command:(NSString*)command args:(NSArray*)args;
/**
When handling an event, a component MUST call either record:command:args or continueRecording before returning. Neglecting to do so will permanently suspend the FoneMonkey console.
*/
+ (void) continueRecording;
/**
Play the supplied array of FMCommandEvents.
@return nil if all comamnds run successfully and an error or failure message otherwise.
*/
+ (NSString*) playCommands:(NSArray*)commands;
/**
Play the commands from the named script file.
@return nil if all comamnds run successfully and an error or failure message otherwise.
*/
+ (NSString*) playFile:(NSString*)file;
/**
Find the view with the specified monkeyID and class.
@param monkeyID the id to search for
@param className the string name of the class
@return the view or nil if no view is found.
*/
+ (UIView*) viewWithMonkeyID:(NSString*)monkeyID havingClass:(NSString*)className;
@end