Xamarin.UITest.xml 228 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Xamarin.UITest</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Xamarin.UITest.Android.AndroidApp">
  8. <summary>
  9. Represents a running Android application.
  10. </summary>
  11. </member>
  12. <member name="M:Xamarin.UITest.Android.AndroidApp.#ctor(Xamarin.UITest.Configuration.IAndroidAppConfiguration)">
  13. <summary>
  14. Main entry point for creating Android applications. Should not be called directly
  15. but instead be invoked through the use of <see cref="T:Xamarin.UITest.ConfigureApp" />.
  16. </summary>
  17. <param name="appConfiguration">The app configuration. Should be generated from <see cref="T:Xamarin.UITest.ConfigureApp" />.</param>
  18. </member>
  19. <member name="M:Xamarin.UITest.Android.AndroidApp.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  20. <summary>
  21. Queries view objects using the fluent API. Defaults to only return view objects that are visible.
  22. </summary>
  23. <param name="query">Entry point for the fluent API to specify the element. If left as <c>null</c> returns all visible view objects.</param>
  24. <returns>An array representing the matched view objects.</returns>
  25. </member>
  26. <member name="M:Xamarin.UITest.Android.AndroidApp.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery})">
  27. <summary>
  28. Queries web view objects using the fluent API. Defaults to only return view objects that are visible.
  29. </summary>
  30. <param name="query">Entry point for the fluent API to specify the element. If left as <c>null</c> returns all visible view objects.</param>
  31. <returns>An array representing the matched view objects.</returns>
  32. </member>
  33. <member name="M:Xamarin.UITest.Android.AndroidApp.Query``1(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppTypedSelector{``0}})">
  34. <summary>
  35. Queries view objects values using the fluent API.
  36. </summary>
  37. <param name="query">Entry point for the fluent API to specify the element. If left as <c>null</c> returns all visible view objects.</param>
  38. <returns>An array containing the values of the matched view objects.</returns>
  39. </member>
  40. <member name="M:Xamarin.UITest.Android.AndroidApp.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.InvokeJSAppQuery})">
  41. <summary>
  42. Invokes Javascript on view objects using the fluent API.
  43. </summary>
  44. <param name="query">Entry point for the fluent API to specify the elements.</param>
  45. <returns>An array of strings representing the results.</returns>
  46. </member>
  47. <member name="M:Xamarin.UITest.Android.AndroidApp.Flash(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  48. <summary>
  49. Highlights the results of the query by making them flash. Specify view elements using the fluent API. Defaults to all view objects that are visible.
  50. </summary>
  51. <param name="query">Entry point for the fluent API to specify the elements. If left as <c>null</c> flashes all visible view objects.</param>
  52. <returns>An array representing the matched view objects.</returns>
  53. </member>
  54. <member name="M:Xamarin.UITest.Android.AndroidApp.EnterText(System.String)">
  55. <summary>
  56. Enters text into the currently focused element.
  57. </summary>
  58. <param name="text">The text to enter.</param>
  59. </member>
  60. <member name="M:Xamarin.UITest.Android.AndroidApp.EnterText(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.String)">
  61. <summary>
  62. Enters text into a matching element that supports it.
  63. </summary>
  64. <param name="query">Entry point for the fluent API to specify the element.</param>
  65. <param name="text">The text to enter.</param>
  66. </member>
  67. <member name="M:Xamarin.UITest.Android.AndroidApp.EnterText(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String)">
  68. <summary>
  69. Enters text into a matching element that supports it.
  70. </summary>
  71. <param name="query">Entry point for the fluent API to specify the element.</param>
  72. <param name="text">The text to enter.</param>
  73. </member>
  74. <member name="M:Xamarin.UITest.Android.AndroidApp.ClearText(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  75. <summary>
  76. Clears text from a matching element that supports it.
  77. </summary>
  78. <param name="query">Entry point for the fluent API to specify the element.</param>
  79. </member>
  80. <member name="M:Xamarin.UITest.Android.AndroidApp.ClearText(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery})">
  81. <summary>
  82. Clears text from a matching element that supports it.
  83. </summary>
  84. <param name="query">Entry point for the fluent API to specify the element.</param>
  85. </member>
  86. <member name="M:Xamarin.UITest.Android.AndroidApp.ClearText">
  87. <summary>
  88. Clears text from the currently focused element.
  89. </summary>
  90. </member>
  91. <member name="M:Xamarin.UITest.Android.AndroidApp.Tap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  92. <summary>
  93. Performs a tap / touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  94. </summary>
  95. <param name="query">Entry point for the fluent API to specify the element.</param>
  96. </member>
  97. <member name="M:Xamarin.UITest.Android.AndroidApp.Tap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery})">
  98. <summary>
  99. Performs a tap / touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  100. </summary>
  101. <param name="query">Entry point for the fluent API to specify the element.</param>
  102. </member>
  103. <member name="M:Xamarin.UITest.Android.AndroidApp.TapCoordinates(System.Single,System.Single)">
  104. <summary>
  105. Performs a tap / touch gesture on the given coordinates.
  106. </summary>
  107. <param name="x">The x coordinate to tap.</param>
  108. <param name="y">The y coordinate to tap.</param>
  109. </member>
  110. <member name="M:Xamarin.UITest.Android.AndroidApp.TouchAndHold(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  111. <summary>
  112. Performs a continuous touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  113. </summary>
  114. <param name="query">Entry point for the fluent API to specify the element.</param>
  115. </member>
  116. <member name="M:Xamarin.UITest.Android.AndroidApp.TouchAndHoldCoordinates(System.Single,System.Single)">
  117. <summary>
  118. Performs a continuous touch gesture on the given coordinates.
  119. </summary>
  120. <param name="x">The x coordinate to touch.</param>
  121. <param name="y">The y coordinate to touch.</param>
  122. </member>
  123. <member name="M:Xamarin.UITest.Android.AndroidApp.DragAndDrop(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.Android.DropLocation,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Int32,System.Action)">
  124. <summary>&gt;
  125. Performs a long touch on an item, followed by dragging the item to a second item and dropping it
  126. </summary>
  127. <param name="from">The query of the item to be dragged</param>"&gt;
  128. <param name="to">The query of the location for the item to be dropped</param><param name="placement">The placement of the drop (on top, above, below, left, right) relative to the to query</param><param name="holdTime">Time to hold on the from query</param><param name="hangTime">Time to hold above the to query</param><param name="steps">The number of steps desired to drag the item, higher for a slower drag</param><param name="afterStepAction">Action to perform after each step</param></member>
  129. <member name="M:Xamarin.UITest.Android.AndroidApp.DoubleTap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  130. <summary>
  131. Performs two quick tap / touch gestures on the matched element. If multiple elements are matched, the first one will be used.
  132. </summary>
  133. <param name="query">Entry point for the fluent API to specify the element.</param>
  134. </member>
  135. <member name="M:Xamarin.UITest.Android.AndroidApp.DoubleTap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery})">
  136. <summary>
  137. Performs two quick tap / touch gestures on the matched element. If multiple elements are matched, the first one will be used.
  138. This version is specifically for queries on web views
  139. </summary>
  140. <param name="query">Entry point for the fluent API to specify the element.</param>
  141. </member>
  142. <member name="M:Xamarin.UITest.Android.AndroidApp.DoubleTapCoordinates(System.Single,System.Single)">
  143. <summary>
  144. Performs a quick double tap / touch gesture on the given coordinates.
  145. </summary>
  146. <param name="x">The x coordinate to touch.</param>
  147. <param name="y">The y coordinate to touch.</param>
  148. </member>
  149. <member name="M:Xamarin.UITest.Android.AndroidApp.PinchToZoomIn(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Nullable{System.TimeSpan})">
  150. <summary>
  151. Performs a pinch gestures on the matched element to zoom the view in. If multiple elements are matched, the first one will be used.
  152. </summary>
  153. <param name="query">Entry point for the fluent API to specify the element.</param>
  154. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  155. </member>
  156. <member name="M:Xamarin.UITest.Android.AndroidApp.PinchToZoomInCoordinates(System.Single,System.Single,System.Nullable{System.TimeSpan})">
  157. <summary>
  158. Performs a pinch gestures to zoom the view in on the given coordinates.
  159. </summary>
  160. <param name="x">The x coordinate of the center of the pinch.</param>
  161. <param name="y">The y coordinate of the center of the pinch.</param>
  162. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  163. </member>
  164. <member name="M:Xamarin.UITest.Android.AndroidApp.PinchToZoomOut(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Nullable{System.TimeSpan})">
  165. <summary>
  166. Performs a pinch gestures on the matched element to zoom the view out. If multiple elements are matched, the first one will be used.
  167. </summary>
  168. <param name="query">Entry point for the fluent API to specify the element.</param>
  169. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  170. </member>
  171. <member name="M:Xamarin.UITest.Android.AndroidApp.PinchToZoomOutCoordinates(System.Single,System.Single,System.Nullable{System.TimeSpan})">
  172. <summary>
  173. Performs a pinch gestures to zoom the view in on the given coordinates.
  174. </summary>
  175. <param name="x">The x coordinate of the center of the pinch.</param>
  176. <param name="y">The y coordinate of the center of the pinch.</param>
  177. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  178. </member>
  179. <member name="M:Xamarin.UITest.Android.AndroidApp.DragCoordinates(System.Single,System.Single,System.Single,System.Single)">
  180. <summary>
  181. Performs a continuous drag gesture between 2 points.
  182. </summary>
  183. <param name="fromX">The x coordinate to start dragging from.</param>
  184. <param name="fromY">The y coordinate to start dragging from.</param>
  185. <param name="toX">The x coordinate to drag to.</param>
  186. <param name="toY">The y coordinate to drag to.</param>
  187. </member>
  188. <member name="M:Xamarin.UITest.Android.AndroidApp.SwipeRight">
  189. <summary>
  190. Performs a right to left swipe gesture.
  191. </summary>
  192. </member>
  193. <member name="M:Xamarin.UITest.Android.AndroidApp.SwipeLeft">
  194. <summary>
  195. Performs a left to right swipe gesture.
  196. </summary>
  197. </member>
  198. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollUp(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy)">
  199. <summary>
  200. Scrolls up on the first element matching query.
  201. </summary>
  202. <param name="withinQuery">Entry point for the fluent API to specify the what element to scroll within.</param>
  203. <param name="strategy">Strategy for scrolling element.</param>
  204. </member>
  205. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollDown(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy)">
  206. <summary>
  207. Scrolls down on the first element matching query.
  208. </summary>
  209. <param name="withinQuery">Entry point for the fluent API to specify the what element to scroll within.</param>
  210. <param name="strategy">Strategy for scrolling element.</param>
  211. </member>
  212. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollLeft(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy)">
  213. <summary>
  214. Scrolls left on the first element matching query.
  215. </summary>
  216. <param name="withinQuery">Entry point for the fluent API to specify the what element to scroll within.</param>
  217. <param name="strategy">Strategy for scrolling element.</param>
  218. </member>
  219. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollRight(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy)">
  220. <summary>
  221. Scrolls right on the first element matching query.
  222. </summary>
  223. <param name="withinQuery">Entry point for the fluent API to specify the what element to scroll within.</param>
  224. <param name="strategy">Strategy for scrolling element.</param>
  225. </member>
  226. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollUpTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  227. <summary>
  228. Scroll up until an element that mactches the <c>toQuery</c> is shown on the screen.
  229. </summary>
  230. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  231. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  232. <param name="strategy">Strategy for scrolling element.</param>
  233. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  234. </member>
  235. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollUpTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  236. <summary>
  237. Scroll up until an element that mactches the <c>toQuery</c> is shown on the screen.
  238. </summary>
  239. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  240. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  241. <param name="strategy">Strategy for scrolling element.</param>
  242. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  243. </member>
  244. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollDownTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  245. <summary>
  246. Scroll down until an element that mactches the <c>toQuery</c> is shown on the screen.
  247. </summary>
  248. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  249. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  250. <param name="strategy">Strategy for scrolling element.</param>
  251. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  252. </member>
  253. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollDownTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  254. <summary>
  255. Scroll down until an element that mactches the <c>toQuery</c> is shown on the screen.
  256. </summary>
  257. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  258. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  259. <param name="strategy">Strategy for scrolling element.</param>
  260. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  261. </member>
  262. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollLeftTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  263. <summary>
  264. Scroll left until an element that mactches the <c>toQuery</c> is shown on the screen.
  265. </summary>
  266. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  267. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  268. <param name="strategy">Strategy for scrolling element.</param>
  269. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  270. </member>
  271. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollLeftTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  272. <summary>
  273. Scroll left until an element that mactches the <c>toQuery</c> is shown on the screen.
  274. </summary>
  275. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  276. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  277. <param name="strategy">Strategy for scrolling element.</param>
  278. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  279. </member>
  280. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollRightTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  281. <summary>
  282. Scroll right until an element that mactches the <c>toQuery</c> is shown on the screen.
  283. </summary>
  284. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  285. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  286. <param name="strategy">Strategy for scrolling element.</param>
  287. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  288. </member>
  289. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollRightTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  290. <summary>
  291. Scroll right until an element that mactches the <c>toQuery</c> is shown on the screen.
  292. </summary>
  293. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  294. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  295. <param name="strategy">Strategy for scrolling element.</param>
  296. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  297. </member>
  298. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollToVerticalEnd(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  299. <summary>
  300. Scroll the matching element so that its bottom child element is visible. If multiple elements are matched, the first one will be used.
  301. </summary>
  302. <param name="withinQuery">Entry point for the fluent API to specify the elements.</param>
  303. <param name="strategy">Strategy for scrolling element.</param>
  304. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  305. </member>
  306. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollToVerticalStart(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  307. <summary>
  308. Scroll the matching element so that its top child element is visible. If multiple elements are matched, the first one will be used.
  309. <param name="withinQuery">Entry point for the fluent API to specify the elements.</param><param name="strategy">Strategy for scrolling element.</param><param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param></summary>
  310. </member>
  311. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollToHorizontalEnd(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  312. <summary>
  313. Scroll the matching element so that its rightmost child element is visible. If multiple elements are matched, the first one will be used.
  314. </summary>
  315. <param name="withinQuery">Entry point for the fluent API to specify the elements.</param>
  316. <param name="strategy">Strategy for scrolling element.</param>
  317. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  318. </member>
  319. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollToHorizontalStart(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  320. <summary>
  321. Scroll the matching element so that its leftmost child element is visible. If multiple elements are matched, the first one will be used.
  322. <param name="withinQuery">Entry point for the fluent API to specify the elements.</param><param name="strategy">Strategy for scrolling element.</param><param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param></summary>
  323. </member>
  324. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  325. <summary>
  326. Scroll until an element that mactches the <c>toQuery</c> is shown on the screen.
  327. </summary>
  328. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  329. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  330. <param name="strategy">Strategy for scrolling element.</param>
  331. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  332. </member>
  333. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  334. <summary>
  335. Scroll until an element that mactches the <c>toQuery</c> is shown on the screen.
  336. </summary>
  337. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  338. <param name="strategy">Strategy for scrolling element.</param>
  339. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  340. </member>
  341. <member name="M:Xamarin.UITest.Android.AndroidApp.Back">
  342. <summary>
  343. Presses the back button of the device.
  344. </summary>
  345. </member>
  346. <member name="M:Xamarin.UITest.Android.AndroidApp.PressVolumeUp">
  347. <summary>
  348. Presses the volume up button on the device.
  349. </summary>
  350. </member>
  351. <member name="M:Xamarin.UITest.Android.AndroidApp.PressVolumeDown">
  352. <summary>
  353. Presses the volume down button on the device.
  354. </summary>
  355. </member>
  356. <member name="M:Xamarin.UITest.Android.AndroidApp.PressMenu">
  357. <summary>
  358. Presses the menu button of the device.
  359. </summary>
  360. </member>
  361. <member name="M:Xamarin.UITest.Android.AndroidApp.PressEnter">
  362. <summary>
  363. Presses the enter key in the app.
  364. </summary>
  365. </member>
  366. <member name="M:Xamarin.UITest.Android.AndroidApp.PressUserAction(System.Nullable{Xamarin.UITest.Android.UserAction})">
  367. <summary>
  368. Presses the user action in the app.
  369. </summary>
  370. <param name="action">Use Action <c>action</c>, if null then the default action for the focused element is used.</param>
  371. </member>
  372. <member name="M:Xamarin.UITest.Android.AndroidApp.DismissKeyboard">
  373. <summary>
  374. Hides keyboard if present
  375. </summary>
  376. </member>
  377. <member name="M:Xamarin.UITest.Android.AndroidApp.SetOrientationPortrait">
  378. <summary>
  379. Changes the device orientation to portrait mode.
  380. </summary>
  381. </member>
  382. <member name="M:Xamarin.UITest.Android.AndroidApp.SetOrientationLandscape">
  383. <summary>
  384. Changes the device orientation to landscape mode.
  385. </summary>
  386. </member>
  387. <member name="M:Xamarin.UITest.Android.AndroidApp.WaitFor(System.Func{System.Boolean},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  388. <summary>
  389. Generic wait function that will repeatly call the <c>predicate</c> function until it returns <c>true</c>. Throws a <see cref="T:System.TimeoutException" /> if the predicate is not fullfilled within the time limit.
  390. </summary>
  391. <param name="predicate">Predicate function that should return <c>true</c> when waiting is complete.</param>
  392. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  393. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  394. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each call to the predicate.</param>
  395. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the predicate returns <c>true</c>.</param>
  396. </member>
  397. <member name="M:Xamarin.UITest.Android.AndroidApp.WaitForElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  398. <summary>
  399. Wait function that will repeatly query the app until a matching element is found. Throws a <see cref="T:System.TimeoutException" /> if no element is found within the time limit.
  400. </summary>
  401. <param name="query">Entry point for the fluent API to specify the element.</param>
  402. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  403. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  404. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  405. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element has been found.</param>
  406. <returns>An array representing the matched view objects.</returns>
  407. </member>
  408. <member name="M:Xamarin.UITest.Android.AndroidApp.WaitForNoElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  409. <summary>
  410. Wait function that will repeatly query the app until a matching element is no longer found. Throws a <see cref="T:System.TimeoutException" /> if the element is visible at the end of the time limit.
  411. </summary>
  412. <param name="query">Entry point for the fluent API to specify the element.</param>
  413. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  414. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  415. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  416. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element is no longer visible.</param>
  417. </member>
  418. <member name="M:Xamarin.UITest.Android.AndroidApp.WaitForElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  419. <summary>
  420. Wait function that will repeatly query the app until a matching element is found. Throws a <see cref="T:System.TimeoutException" /> if no element is found within the time limit.
  421. </summary>
  422. <param name="query">Entry point for the fluent API to specify the element.</param>
  423. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  424. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  425. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  426. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element has been found.</param>
  427. <returns>An array representing the matched view objects.</returns>
  428. </member>
  429. <member name="M:Xamarin.UITest.Android.AndroidApp.WaitForNoElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  430. <summary>
  431. Wait function that will repeatly query the app until a matching element is no longer found. Throws a <see cref="T:System.TimeoutException" /> if the element is visible at the end of the time limit.
  432. </summary>
  433. <param name="query">Entry point for the fluent API to specify the element.</param>
  434. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  435. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  436. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  437. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element is no longer visible.</param>
  438. </member>
  439. <member name="M:Xamarin.UITest.Android.AndroidApp.Screenshot(System.String)">
  440. <summary>
  441. Takes a screenshot of the app in it's current state. This is used to denote test steps in the Xamarin Test Cloud.
  442. </summary>
  443. <param name="title">The title of screenshot, used as step name.</param>
  444. <returns>The screenshot file.</returns>
  445. </member>
  446. <member name="P:Xamarin.UITest.Android.AndroidApp.Print">
  447. <summary>
  448. Contains helper methods for outputting the result of queries instead of resorting to <see cref="T:System.Console" />.
  449. </summary>
  450. </member>
  451. <member name="M:Xamarin.UITest.Android.AndroidApp.Repl">
  452. <summary>
  453. Starts an interactive REPL (Read-Eval-Print-Loop) for app exploration and pauses test execution until it is closed.
  454. </summary>
  455. </member>
  456. <member name="M:Xamarin.UITest.Android.AndroidApp.Invoke(System.String,System.Object)">
  457. <summary>
  458. Invokes a method on the app's main activity. For Xamarin apps, methods must be exposed using attributes as shown below.
  459. Android example in activity:
  460. <code>
  461. [Export]
  462. public string MyInvokeMethod(string arg)
  463. {
  464. return "uitest";
  465. }
  466. </code></summary>
  467. <param name="methodName">The name of the method to invoke.</param>
  468. <param name="argument">The argument to pass to the method.</param>
  469. <returns>The result of the invocation.</returns>
  470. </member>
  471. <member name="P:Xamarin.UITest.Android.AndroidApp.Config">
  472. <summary>
  473. Contains runtime information about the currently running device.
  474. </summary>
  475. </member>
  476. <member name="P:Xamarin.UITest.Android.AndroidApp.Xamarin#UITest#IApp#Device">
  477. <summary>
  478. Runtime information and control of the currently running device.
  479. </summary>
  480. </member>
  481. <member name="P:Xamarin.UITest.Android.AndroidApp.Device">
  482. <summary>
  483. Runtime information and control of the currently running device.
  484. </summary>
  485. </member>
  486. <member name="P:Xamarin.UITest.Android.AndroidApp.TestServer">
  487. <summary>
  488. Allows HTTP access to the test server running on the device.
  489. </summary>
  490. </member>
  491. <member name="M:Xamarin.UITest.Android.AndroidApp.Query(System.String)">
  492. <summary>
  493. Queries view objects using the fluent API. Defaults to only return view objects that are visible.
  494. </summary>
  495. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  496. <returns>An array representing the matched view objects.</returns>
  497. </member>
  498. <member name="M:Xamarin.UITest.Android.AndroidApp.Flash(System.String)">
  499. <summary>
  500. Highlights the results of the query by making them flash. Specify view elements using marked string.
  501. </summary>
  502. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  503. <returns>An array representing the matched view objects.</returns>
  504. </member>
  505. <member name="M:Xamarin.UITest.Android.AndroidApp.EnterText(System.String,System.String)">
  506. <summary>
  507. Enters text into a matching element that supports it.
  508. </summary>
  509. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  510. <param name="text">The text to enter.</param>
  511. </member>
  512. <member name="M:Xamarin.UITest.Android.AndroidApp.ClearText(System.String)">
  513. <summary>
  514. Clears text from a matching element that supports it.
  515. </summary>
  516. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  517. </member>
  518. <member name="M:Xamarin.UITest.Android.AndroidApp.Tap(System.String)">
  519. <summary>
  520. Performs a tap / touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  521. </summary>
  522. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  523. </member>
  524. <member name="M:Xamarin.UITest.Android.AndroidApp.TouchAndHold(System.String)">
  525. <summary>
  526. Performs a continuous touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  527. </summary>
  528. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  529. </member>
  530. <member name="M:Xamarin.UITest.Android.AndroidApp.DoubleTap(System.String)">
  531. <summary>
  532. Performs two quick tap / touch gestures on the matched element. If multiple elements are matched, the first one will be used.
  533. </summary>
  534. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  535. </member>
  536. <member name="M:Xamarin.UITest.Android.AndroidApp.PinchToZoomIn(System.String,System.Nullable{System.TimeSpan})">
  537. <summary>
  538. Performs a pinch gestures on the matched element to zoom the view in. If multiple elements are matched, the first one will be used.
  539. </summary>
  540. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  541. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  542. </member>
  543. <member name="M:Xamarin.UITest.Android.AndroidApp.PinchToZoomOut(System.String,System.Nullable{System.TimeSpan})">
  544. <summary>
  545. Performs a pinch gestures on the matched element to zoom the view out. If multiple elements are matched, the first one will be used.
  546. </summary>
  547. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  548. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  549. </member>
  550. <member name="M:Xamarin.UITest.Android.AndroidApp.WaitForNoElement(System.String,System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  551. <summary>
  552. Wait function that will repeatly query the app until a matching element is no longer found. Throws a <see cref="T:System.TimeoutException" /> if the element is visible at the end of the time limit.
  553. </summary>
  554. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  555. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  556. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  557. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  558. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element is no longer visible.</param>
  559. </member>
  560. <member name="M:Xamarin.UITest.Android.AndroidApp.WaitForElement(System.String,System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  561. <summary>
  562. Wait function that will repeatly query the app until a matching element is found. Throws a <see cref="T:System.TimeoutException" /> if no element is found within the time limit.
  563. </summary>
  564. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  565. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  566. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  567. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  568. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element has been found.</param>
  569. <returns>An array representing the matched view objects.</returns>
  570. </member>
  571. <member name="M:Xamarin.UITest.Android.AndroidApp.DragAndDrop(System.String,System.String,Xamarin.UITest.Android.DropLocation,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Int32,System.Action)">
  572. <summary>
  573. Performs a long touch on an item, followed by dragging the item to a second item and dropping it
  574. </summary>
  575. <param name="fromMarked">Marked selector for the item to be dragged. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  576. <param name="toMarked">Marked selector for the location for the item to be dropped. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  577. <param name="placement">The placement of the drop (on top, above, below, left, right) relative to the to query</param>
  578. <param name="holdTime">Time to hold on the from query</param>
  579. <param name="hangTime">Time to hold above the to query</param>
  580. <param name="steps">The number of steps desired to drag the item, higher for a slower drag</param>
  581. <param name="afterStepAction">Action to perform after each step</param>
  582. </member>
  583. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollUp(System.String,Xamarin.UITest.ScrollStrategy)">
  584. <summary>
  585. Scrolls up on the first element matching query.
  586. </summary>
  587. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  588. <param name="strategy">Strategy for scrolling element.</param>
  589. </member>
  590. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollDown(System.String,Xamarin.UITest.ScrollStrategy)">
  591. <summary>
  592. Scrolls down on the first element matching query.
  593. </summary>
  594. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  595. <param name="strategy">Strategy for scrolling element.</param>
  596. </member>
  597. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollLeft(System.String,Xamarin.UITest.ScrollStrategy)">
  598. <summary>
  599. Scrolls left on the first element matching query.
  600. </summary>
  601. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  602. <param name="strategy">Strategy for scrolling element.</param>
  603. </member>
  604. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollRight(System.String,Xamarin.UITest.ScrollStrategy)">
  605. <summary>
  606. Scrolls right on the first element matching query.
  607. </summary>
  608. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  609. <param name="strategy">Strategy for scrolling element.</param>
  610. </member>
  611. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollUpTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  612. <summary>
  613. Scroll up until an element that mactches the <c>toMarked</c> is shown on the screen.
  614. </summary>
  615. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  616. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  617. <param name="strategy">Strategy for scrolling element.</param>
  618. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  619. </member>
  620. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollUpTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  621. <summary>
  622. Scroll up until an element that mactches the <c>toMarked</c> is shown on the screen.
  623. </summary>
  624. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  625. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  626. <param name="strategy">Strategy for scrolling element.</param>
  627. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  628. </member>
  629. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollDownTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  630. <summary>
  631. Scroll down until an element that mactches the <c>toMarked</c> is shown on the screen.
  632. </summary>
  633. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  634. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  635. <param name="strategy">Strategy for scrolling element.</param>
  636. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  637. </member>
  638. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollDownTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  639. <summary>
  640. Scroll down until an element that mactches the <c>toMarked</c> is shown on the screen.
  641. </summary>
  642. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  643. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  644. <param name="strategy">Strategy for scrolling element.</param>
  645. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  646. </member>
  647. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollLeftTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  648. <summary>
  649. Scroll left until an element that mactches the <c>toMarked</c> is shown on the screen.
  650. </summary>
  651. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  652. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  653. <param name="strategy">Strategy for scrolling element.</param>
  654. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  655. </member>
  656. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollLeftTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  657. <summary>
  658. Scroll left until an element that mactches the <c>toMarked</c> is shown on the screen.
  659. </summary>
  660. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  661. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  662. <param name="strategy">Strategy for scrolling element.</param>
  663. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  664. </member>
  665. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollRightTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  666. <summary>
  667. Scroll right until an element that mactches the <c>toMarked</c> is shown on the screen.
  668. </summary>
  669. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  670. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  671. <param name="strategy">Strategy for scrolling element.</param>
  672. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  673. </member>
  674. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollRightTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  675. <summary>
  676. Scroll right until an element that mactches the <c>toMarked</c> is shown on the screen.
  677. </summary>
  678. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  679. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  680. <param name="strategy">Strategy for scrolling element.</param>
  681. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  682. </member>
  683. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollToVerticalEnd(System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  684. <summary>
  685. Scroll the matching element so that its bottom child element is visible. If multiple elements are matched, the first one will be used.
  686. </summary>
  687. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  688. <param name="strategy">Strategy for scrolling element.</param>
  689. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  690. </member>
  691. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollToVerticalStart(System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  692. <summary>
  693. Scroll the matching element so that its top child element is visible. If multiple elements are matched, the first one will be used.
  694. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param><param name="strategy">Strategy for scrolling element.</param><param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param></summary>
  695. </member>
  696. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollToHorizontalEnd(System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  697. <summary>
  698. Scroll the matching element so that its rightmost child element is visible. If multiple elements are matched, the first one will be used.
  699. </summary>
  700. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  701. <param name="strategy">Strategy for scrolling element.</param>
  702. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  703. </member>
  704. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollToHorizontalStart(System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  705. <summary>
  706. Scroll the matching element so that its leftmost child element is visible. If multiple elements are matched, the first one will be used.
  707. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param><param name="strategy">Strategy for scrolling element.</param><param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param></summary>
  708. </member>
  709. <member name="M:Xamarin.UITest.Android.AndroidApp.ScrollTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  710. <summary>
  711. Scroll until an element that mactches the <c>toMarked</c> is shown on the screen.
  712. </summary>
  713. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  714. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  715. <param name="strategy">Strategy for scrolling element.</param>
  716. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  717. </member>
  718. <member name="T:Xamarin.UITest.Android.AndroidConfig">
  719. <summary>
  720. Represents runtime information about the currently running device.
  721. </summary>
  722. </member>
  723. <member name="M:Xamarin.UITest.Android.AndroidConfig.#ctor(System.Uri,System.IO.FileInfo)">
  724. <summary>
  725. Creates a new instance.
  726. </summary>
  727. <param name="deviceUri">The uri of the device.</param>
  728. <param name="apkFile">The running apk file.</param>
  729. </member>
  730. <member name="P:Xamarin.UITest.Android.AndroidConfig.DeviceUri">
  731. <summary>
  732. The uri of the device.
  733. </summary>
  734. </member>
  735. <member name="P:Xamarin.UITest.Android.AndroidConfig.ApkFile">
  736. <summary>
  737. The currently running apk file.
  738. </summary>
  739. </member>
  740. <member name="T:Xamarin.UITest.Android.AndroidDevice">
  741. <summary>
  742. Runtime information and control of device.
  743. </summary>
  744. </member>
  745. <member name="P:Xamarin.UITest.Android.AndroidDevice.DeviceUri">
  746. <summary>
  747. The uri of the device.
  748. </summary>
  749. </member>
  750. <member name="P:Xamarin.UITest.Android.AndroidDevice.DeviceIdentifier">
  751. <summary>
  752. The identifier of the device.
  753. </summary>
  754. </member>
  755. <member name="M:Xamarin.UITest.Android.AndroidDevice.SetLocation(System.Double,System.Double)">
  756. <summary>
  757. Change GPS location of the device.
  758. </summary>
  759. <param name="latitude">
  760. </param>
  761. <param name="longitude">
  762. </param>
  763. </member>
  764. <member name="T:Xamarin.UITest.Configuration.IGenericAppConfiguration">
  765. <summary>
  766. Shared configuration for apps. Not to be used directly, should be created by using the fluent <see cref="T:Xamarin.UITest.ConfigureApp" /> API.
  767. </summary>
  768. </member>
  769. <member name="P:Xamarin.UITest.Configuration.IGenericAppConfiguration.Debug">
  770. <summary>
  771. Enable debug logging.
  772. </summary>
  773. </member>
  774. <member name="P:Xamarin.UITest.Configuration.IGenericAppConfiguration.DeviceIp">
  775. <summary>
  776. The ip adress of the device.
  777. </summary>
  778. </member>
  779. <member name="P:Xamarin.UITest.Configuration.IGenericAppConfiguration.DevicePort">
  780. <summary>
  781. The port to use for communication with the test server.
  782. </summary>
  783. </member>
  784. <member name="P:Xamarin.UITest.Configuration.IGenericAppConfiguration.EnableScreenshots">
  785. <summary>
  786. Enable screenshots. Local screenshots are disabled by default to speed up tests.
  787. </summary>
  788. </member>
  789. <member name="P:Xamarin.UITest.Configuration.IGenericAppConfiguration.ApiKey">
  790. <summary>
  791. The Xamarin Test Cloud api key to use for activation.
  792. </summary>
  793. </member>
  794. <member name="P:Xamarin.UITest.Configuration.IGenericAppConfiguration.LogDirectory">
  795. <summary>
  796. Specify the location of the log directory for local test runs.
  797. </summary>
  798. </member>
  799. <member name="P:Xamarin.UITest.Configuration.IGenericAppConfiguration.IdeIntegrationMode">
  800. <summary>
  801. The IDE integration mode. Decides what settings to use in case of both explicit configuration and active IDE integration.
  802. </summary>
  803. </member>
  804. <member name="P:Xamarin.UITest.Configuration.IGenericAppConfiguration.DisableSpecFlowIntegration">
  805. <summary>
  806. Whether to disables automatic screenshot generation after each SpecFlow step.
  807. </summary>
  808. </member>
  809. <member name="T:Xamarin.UITest.Configuration.StartAction">
  810. <summary>
  811. The desired state of the app after test initialization. Either the test framework can start the app or connect to an already running app in more advanced scenarios.
  812. </summary>
  813. </member>
  814. <member name="F:Xamarin.UITest.Configuration.StartAction.LaunchApp">
  815. <summary>
  816. Start the app after successful configuration.
  817. </summary>
  818. </member>
  819. <member name="F:Xamarin.UITest.Configuration.StartAction.ConnectToApp">
  820. <summary>
  821. Use the given configuration to connect to an already running app.
  822. </summary>
  823. </member>
  824. <member name="T:Xamarin.UITest.ConfigureApp">
  825. <summary>
  826. Main entry point for <c>Xamarin.UITest</c>. This is a fluent API that allows you to
  827. configure your app for either Android or iOS and start it.
  828. </summary>
  829. </member>
  830. <member name="M:Xamarin.UITest.ConfigureApp.DeviceIp(System.String)">
  831. <summary>
  832. Configures the ip address of the device. Generally best left unset unless you are
  833. running an iOS application on a physical device.
  834. </summary>
  835. <param name="ipAddress">The ip address of the device.</param>
  836. </member>
  837. <member name="M:Xamarin.UITest.ConfigureApp.DevicePort(System.Int32)">
  838. <summary>
  839. Configures the port of the device. Generally best left unset.
  840. </summary>
  841. <param name="port">The port of the Calabash HTTP server on the device.</param>
  842. </member>
  843. <member name="P:Xamarin.UITest.ConfigureApp.iOS">
  844. <summary>
  845. Specifies that the app is an iOS app.
  846. </summary>
  847. </member>
  848. <member name="P:Xamarin.UITest.ConfigureApp.Android">
  849. <summary>
  850. Specifies that the app is an Android app.
  851. </summary>
  852. </member>
  853. <member name="M:Xamarin.UITest.ConfigureApp.Debug">
  854. <summary>
  855. Enables debug logging from the test runner.
  856. </summary>
  857. </member>
  858. <member name="T:Xamarin.UITest.Events.AfterAppStartedAttribute">
  859. <summary>
  860. Can be used on static methods to register for notifications immediately after an app instance has been started.
  861. Valid parameters:
  862. - Zero arguments
  863. - One argument of type <see cref="T:Xamarin.UITest.IApp" />.
  864. - One argument of type <see cref="T:Xamarin.UITest.Android.AndroidApp" />.
  865. - One argument of type <see cref="T:Xamarin.UITest.iOS.iOSApp" />.
  866. </summary>
  867. </member>
  868. <member name="T:Xamarin.UITest.IDevice">
  869. <summary>
  870. Runtime information and control of device.
  871. </summary>
  872. </member>
  873. <member name="P:Xamarin.UITest.IDevice.DeviceUri">
  874. <summary>
  875. The uri of the device.
  876. </summary>
  877. </member>
  878. <member name="P:Xamarin.UITest.IDevice.DeviceIdentifier">
  879. <summary>
  880. The identifier of the device.
  881. </summary>
  882. </member>
  883. <member name="M:Xamarin.UITest.IDevice.SetLocation(System.Double,System.Double)">
  884. <summary>
  885. Change GPS location of the device.
  886. </summary>
  887. <param name="latitude">
  888. </param>
  889. <param name="longitude">
  890. </param>
  891. </member>
  892. <member name="T:Xamarin.UITest.iOS.iOSConfig">
  893. <summary>
  894. Represents runtime information about the currently running app / device.
  895. </summary>
  896. </member>
  897. <member name="P:Xamarin.UITest.iOS.iOSConfig.DeviceUri">
  898. <summary>
  899. The uri of the device.
  900. </summary>
  901. </member>
  902. <member name="P:Xamarin.UITest.iOS.iOSConfig.IsPhone">
  903. <summary>
  904. Whether the current test is running on a phone.
  905. </summary>
  906. </member>
  907. <member name="P:Xamarin.UITest.iOS.iOSConfig.IsTablet">
  908. <summary>
  909. Whether the current test is running on a tablet.
  910. </summary>
  911. </member>
  912. <member name="T:Xamarin.UITest.iOS.iOSDevice">
  913. <summary>
  914. Runtime information and control of device.
  915. </summary>
  916. </member>
  917. <member name="P:Xamarin.UITest.iOS.iOSDevice.DeviceUri">
  918. <summary>
  919. The uri of the device.
  920. </summary>
  921. </member>
  922. <member name="P:Xamarin.UITest.iOS.iOSDevice.DeviceIdentifier">
  923. <summary>
  924. The identifier of the device.
  925. </summary>
  926. </member>
  927. <member name="M:Xamarin.UITest.iOS.iOSDevice.SetLocation(System.Double,System.Double)">
  928. <summary>
  929. Change GPS location of the device.
  930. </summary>
  931. <param name="latitude">
  932. </param>
  933. <param name="longitude">
  934. </param>
  935. </member>
  936. <member name="P:Xamarin.UITest.iOS.iOSDevice.IsPhone">
  937. <summary>
  938. Whether the current test is running on a phone.
  939. </summary>
  940. </member>
  941. <member name="P:Xamarin.UITest.iOS.iOSDevice.IsTablet">
  942. <summary>
  943. Whether the current test is running on a tablet.
  944. </summary>
  945. </member>
  946. <member name="T:Xamarin.UITest.ITestServer">
  947. <summary>
  948. Provides access to the test server running on the device for advanced scenarios.
  949. </summary>
  950. </member>
  951. <member name="M:Xamarin.UITest.ITestServer.Post(System.String,System.Object)">
  952. <summary>
  953. Performs an HTTP POST request to the test server.
  954. </summary>
  955. <param name="endpoint">The path of the request, which will be appended on the uri of the test server.</param>
  956. <param name="arguments">An object that will be serialized as json and posted to the test server.</param>
  957. <returns>The body of the the reponse.</returns>
  958. </member>
  959. <member name="M:Xamarin.UITest.ITestServer.Put(System.String,System.Byte[])">
  960. <summary>
  961. Performs an HTTP PUT request to the test server.
  962. </summary>
  963. <param name="endpoint">The path of the request, which will be appended on the uri of the test server.</param>
  964. <param name="data">The byte[] data to put.</param>
  965. <returns>The body of the the reponse.</returns>
  966. </member>
  967. <member name="M:Xamarin.UITest.ITestServer.Get(System.String)">
  968. <summary>
  969. Performs an HTTP GET request to the test server.
  970. </summary>
  971. <param name="endpoint">The path of the request, which will be appended on the uri of the test server.</param>
  972. <returns>The body of the the reponse.</returns>
  973. </member>
  974. <member name="T:Xamarin.UITest.Queries.AppPrintHelper">
  975. <summary>
  976. A fluent API for making test output easier. Mirrored query methods from the app classes that print directly to <see cref="T:System.Console" />.
  977. </summary>
  978. </member>
  979. <member name="M:Xamarin.UITest.Queries.AppPrintHelper.Visible">
  980. <summary>
  981. Prints all the visible view elements to <see cref="T:System.Console" />.
  982. </summary>
  983. </member>
  984. <member name="M:Xamarin.UITest.Queries.AppPrintHelper.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  985. <summary>
  986. Prints the view elements matched by <c>query</c> to <see cref="T:System.Console" />.
  987. </summary>
  988. <param name="query">Entry point for the fluent API to specify the element. If left as <c>null</c> returns all visible view objects.</param>
  989. </member>
  990. <member name="M:Xamarin.UITest.Queries.AppPrintHelper.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery})">
  991. <summary>
  992. Prints the view elements matched by <c>query</c> to <see cref="T:System.Console" />.
  993. </summary>
  994. <param name="query">Entry point for the fluent API to specify the element. If left as <c>null</c> returns all visible view objects.</param>
  995. </member>
  996. <member name="M:Xamarin.UITest.Queries.AppPrintHelper.Query``1(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppTypedSelector{``0}})">
  997. <summary>
  998. Prints the properties matched by <c>query</c> to <see cref="T:System.Console" />.
  999. </summary>
  1000. <param name="typedSelector">Entry point for the fluent API to specify the property.</param>
  1001. </member>
  1002. <member name="M:Xamarin.UITest.Queries.AppPrintHelper.Tree(System.Nullable{System.Boolean})">
  1003. <summary>
  1004. Prints a tree of the visible view elements.
  1005. </summary>
  1006. <param name="console">Output to console in color instead of default logger.</param>
  1007. </member>
  1008. <member name="T:Xamarin.UITest.Queries.AppResult">
  1009. <summary>
  1010. Representation of a view element in the app.
  1011. </summary>
  1012. </member>
  1013. <member name="M:Xamarin.UITest.Queries.AppResult.#ctor">
  1014. <summary>
  1015. Initializes a new instance of the <see cref="T:Xamarin.UITest.Queries.AppResult" /> class.
  1016. </summary>
  1017. </member>
  1018. <member name="P:Xamarin.UITest.Queries.AppResult.Id">
  1019. <summary>
  1020. The identifier of the view element.
  1021. For Android: The id of the element.
  1022. For iOS: The accessibilityIdentifier of the element.
  1023. </summary>
  1024. </member>
  1025. <member name="P:Xamarin.UITest.Queries.AppResult.Description">
  1026. <summary>
  1027. A platform specific text representation of the view element.
  1028. </summary>
  1029. </member>
  1030. <member name="P:Xamarin.UITest.Queries.AppResult.Rect">
  1031. <summary>
  1032. The <see cref="T:Xamarin.UITest.Queries.AppRect" /> rectangle representing the elements position and size.
  1033. </summary>
  1034. </member>
  1035. <member name="P:Xamarin.UITest.Queries.AppResult.Label">
  1036. <summary>
  1037. The label of the view element.
  1038. For Android: Empty
  1039. For iOS: The accessibilityLabel of the element.
  1040. </summary>
  1041. </member>
  1042. <member name="P:Xamarin.UITest.Queries.AppResult.Text">
  1043. <summary>
  1044. The text of the view element.
  1045. </summary>
  1046. </member>
  1047. <member name="P:Xamarin.UITest.Queries.AppResult.Class">
  1048. <summary>
  1049. The class of the view element.
  1050. </summary>
  1051. </member>
  1052. <member name="P:Xamarin.UITest.Queries.AppResult.Enabled">
  1053. <summary>
  1054. Whether the element is enabled or not.
  1055. </summary>
  1056. </member>
  1057. <member name="T:Xamarin.UITest.Queries.AppRect">
  1058. <summary>
  1059. Representation of a view elements position and size.
  1060. </summary>
  1061. </member>
  1062. <member name="P:Xamarin.UITest.Queries.AppRect.Width">
  1063. <summary>
  1064. The width of the element.
  1065. </summary>
  1066. </member>
  1067. <member name="P:Xamarin.UITest.Queries.AppRect.Height">
  1068. <summary>
  1069. The height of the element.
  1070. </summary>
  1071. </member>
  1072. <member name="P:Xamarin.UITest.Queries.AppRect.X">
  1073. <summary>
  1074. The X coordinate of the top left corner of the element.
  1075. </summary>
  1076. </member>
  1077. <member name="P:Xamarin.UITest.Queries.AppRect.Y">
  1078. <summary>
  1079. The Y coordinate of the top left corner of the element.
  1080. </summary>
  1081. </member>
  1082. <member name="P:Xamarin.UITest.Queries.AppRect.CenterX">
  1083. <summary>
  1084. The X coordinate of the center of the element.
  1085. </summary>
  1086. </member>
  1087. <member name="P:Xamarin.UITest.Queries.AppRect.CenterY">
  1088. <summary>
  1089. The Y coordinate of the center of the element.
  1090. </summary>
  1091. <value>The center y.</value>
  1092. </member>
  1093. <member name="M:Xamarin.UITest.Queries.AppRect.ToString">
  1094. <summary>
  1095. Returns a <see cref="T:System.String" /> that represents the current <see cref="T:Xamarin.UITest.Queries.AppRect" />.
  1096. </summary>
  1097. </member>
  1098. <member name="T:Xamarin.UITest.Queries.AppWebQuery">
  1099. <summary>
  1100. Fluent query API for specifying view elements predicates for web elements.
  1101. </summary>
  1102. </member>
  1103. <member name="M:Xamarin.UITest.Queries.AppWebQuery.#ctor(System.Collections.Generic.IEnumerable{Xamarin.UITest.Queries.Tokens.IQueryToken},Xamarin.UITest.Queries.QueryPlatform,System.Object[])">
  1104. <summary>
  1105. Initial constructor for web element queries. Should not be called directly, but used as part of the fluent API in the app classes.
  1106. </summary>
  1107. <param name="initialTokens">The tokens of the existing <see cref="T:Xamarin.UITest.Queries.AppQuery" />.</param>
  1108. <param name="queryPlatform">The query target platform.</param>
  1109. <param name="tokens">The additional tokens to add.</param>
  1110. </member>
  1111. <member name="P:Xamarin.UITest.Queries.AppWebQuery.Xamarin#UITest#Queries#ITokenContainer#Tokens">
  1112. <summary>
  1113. The tokens of the current query.
  1114. </summary>
  1115. </member>
  1116. <member name="M:Xamarin.UITest.Queries.AppWebQuery.Index(System.Int32)">
  1117. <summary>
  1118. Matches the nth element of the currently matched elements.
  1119. </summary>
  1120. <param name="index">The zero-based index of the element to match.</param>
  1121. </member>
  1122. <member name="M:Xamarin.UITest.Queries.AppWebQuery.ToString">
  1123. <summary>
  1124. Converts the string into it's Calabash query equivalent.
  1125. </summary>
  1126. </member>
  1127. <member name="T:Xamarin.UITest.Queries.AppWebRect">
  1128. <summary>
  1129. Representation of a web elements position and size.
  1130. </summary>
  1131. </member>
  1132. <member name="P:Xamarin.UITest.Queries.AppWebRect.Width">
  1133. <summary>
  1134. The width of the element.
  1135. </summary>
  1136. </member>
  1137. <member name="P:Xamarin.UITest.Queries.AppWebRect.Height">
  1138. <summary>
  1139. The height of the element.
  1140. </summary>
  1141. </member>
  1142. <member name="P:Xamarin.UITest.Queries.AppWebRect.CenterX">
  1143. <summary>
  1144. The X coordinate of the center of the element.
  1145. </summary>
  1146. </member>
  1147. <member name="P:Xamarin.UITest.Queries.AppWebRect.CenterY">
  1148. <summary>
  1149. The Y coordinate of the center of the element."
  1150. </summary>
  1151. </member>
  1152. <member name="P:Xamarin.UITest.Queries.AppWebRect.Top">
  1153. <summary>
  1154. The top property of the element.
  1155. </summary>
  1156. </member>
  1157. <member name="P:Xamarin.UITest.Queries.AppWebRect.Bottom">
  1158. <summary>
  1159. The bottom property of the element.
  1160. </summary>
  1161. </member>
  1162. <member name="P:Xamarin.UITest.Queries.AppWebRect.Left">
  1163. <summary>
  1164. The left property of the element.
  1165. </summary>
  1166. </member>
  1167. <member name="P:Xamarin.UITest.Queries.AppWebRect.Right">
  1168. <summary>
  1169. The right property of the element.
  1170. </summary>
  1171. </member>
  1172. <member name="P:Xamarin.UITest.Queries.AppWebRect.X">
  1173. <summary>
  1174. The X property of the element, unit is screen coordinates
  1175. </summary>
  1176. </member>
  1177. <member name="P:Xamarin.UITest.Queries.AppWebRect.Y">
  1178. <summary>
  1179. The Y property of the element, unit is screen coordinates
  1180. </summary>
  1181. </member>
  1182. <member name="T:Xamarin.UITest.Queries.AppWebResult">
  1183. <summary>
  1184. Representation of a web element in the app.
  1185. </summary>
  1186. </member>
  1187. <member name="P:Xamarin.UITest.Queries.AppWebResult.Id">
  1188. <summary>
  1189. The HTML id of the element.
  1190. </summary>
  1191. </member>
  1192. <member name="P:Xamarin.UITest.Queries.AppWebResult.NodeType">
  1193. <summary>
  1194. The node type of the element.
  1195. </summary>
  1196. </member>
  1197. <member name="P:Xamarin.UITest.Queries.AppWebResult.NodeName">
  1198. <summary>
  1199. The tag name of the element.
  1200. </summary>
  1201. </member>
  1202. <member name="P:Xamarin.UITest.Queries.AppWebResult.Class">
  1203. <summary>
  1204. The CSS class of the element.
  1205. </summary>
  1206. </member>
  1207. <member name="P:Xamarin.UITest.Queries.AppWebResult.Html">
  1208. <summary>
  1209. The raw HTML of the element.
  1210. </summary>
  1211. </member>
  1212. <member name="P:Xamarin.UITest.Queries.AppWebResult.Value">
  1213. <summary>
  1214. The form value of the element.
  1215. </summary>
  1216. </member>
  1217. <member name="P:Xamarin.UITest.Queries.AppWebResult.WebView">
  1218. <summary>
  1219. A platform specific text representation of the containing web view.
  1220. </summary>
  1221. </member>
  1222. <member name="P:Xamarin.UITest.Queries.AppWebResult.TextContent">
  1223. <summary>
  1224. The text content of the element.
  1225. </summary>
  1226. </member>
  1227. <member name="P:Xamarin.UITest.Queries.AppWebResult.Rect">
  1228. <summary>
  1229. The <see cref="T:Xamarin.UITest.Queries.AppWebRect" /> rectangle representing the elements position and size.
  1230. </summary>
  1231. </member>
  1232. <member name="T:Xamarin.UITest.Queries.IInvokeJSAppQuery">
  1233. <summary>
  1234. Helper interface for exposing property from the fluent query API without cluttering the fluent API itself (when using explicit interface implementation).
  1235. </summary>
  1236. </member>
  1237. <member name="T:Xamarin.UITest.Queries.IAppTypedSelector">
  1238. <summary>
  1239. Helper interface for exposing property from the fluent query API without cluttering the fluent API itself (when using explicit interface implementation).
  1240. </summary>
  1241. </member>
  1242. <member name="P:Xamarin.UITest.Queries.IAppTypedSelector.QueryParams">
  1243. <summary>
  1244. The query parameters.
  1245. </summary>
  1246. </member>
  1247. <member name="P:Xamarin.UITest.Queries.IAppTypedSelector.AppQuery">
  1248. <summary>
  1249. The app query.
  1250. </summary>
  1251. </member>
  1252. <member name="P:Xamarin.UITest.Queries.IAppTypedSelector.ExplicitlyRequestedValue">
  1253. <summary>
  1254. The value of the query was explicitly requested.
  1255. </summary>
  1256. </member>
  1257. <member name="T:Xamarin.UITest.Queries.InvokeJSAppQuery">
  1258. <summary>
  1259. Fluent query API for invoking javascipt on Webviews.
  1260. </summary>
  1261. </member>
  1262. <member name="M:Xamarin.UITest.Queries.InvokeJSAppQuery.#ctor(Xamarin.UITest.Queries.AppQuery,System.String)">
  1263. <summary>
  1264. Initial constructor. Should not be called directly, but used as part of the fluent API in the app classes.
  1265. </summary>
  1266. </member>
  1267. <member name="P:Xamarin.UITest.Queries.InvokeJSAppQuery.Xamarin#UITest#Queries#ITokenContainer#Tokens">
  1268. <summary>
  1269. The tokens of the current query.
  1270. </summary>
  1271. </member>
  1272. <member name="T:Xamarin.UITest.Queries.IRect">
  1273. <summary>
  1274. Representation of a view elements position and size.
  1275. </summary>
  1276. </member>
  1277. <member name="P:Xamarin.UITest.Queries.IRect.Width">
  1278. <summary>
  1279. The width of the element.
  1280. </summary>
  1281. </member>
  1282. <member name="P:Xamarin.UITest.Queries.IRect.Height">
  1283. <summary>
  1284. The height of the element.
  1285. </summary>
  1286. </member>
  1287. <member name="P:Xamarin.UITest.Queries.IRect.X">
  1288. <summary>
  1289. The X coordinate of the top left corner of the element.
  1290. </summary>
  1291. </member>
  1292. <member name="P:Xamarin.UITest.Queries.IRect.Y">
  1293. <summary>
  1294. The Y coordinate of the top left corner of the element.
  1295. </summary>
  1296. </member>
  1297. <member name="P:Xamarin.UITest.Queries.IRect.CenterX">
  1298. <summary>
  1299. The X coordinate of the center of the element.
  1300. </summary>
  1301. </member>
  1302. <member name="P:Xamarin.UITest.Queries.IRect.CenterY">
  1303. <summary>
  1304. The Y coordinate of the center of the element.
  1305. </summary>
  1306. <value>The center y.</value>
  1307. </member>
  1308. <member name="T:Xamarin.UITest.Queries.PropertyAppQuery">
  1309. <summary>
  1310. Fluent query API for specifying view elements predicates for properties.
  1311. </summary>
  1312. </member>
  1313. <member name="M:Xamarin.UITest.Queries.PropertyAppQuery.#ctor(Xamarin.UITest.Queries.QueryPlatform,Xamarin.UITest.Queries.AppQuery,System.String)">
  1314. <summary>
  1315. Initial constructor for property queries. Should not be called directly, but used as part of the fluent API in the app classes.
  1316. </summary>
  1317. <param name="queryPlatform">The query target platform.</param>
  1318. <param name="appQuery">The existing <see cref="T:Xamarin.UITest.Queries.AppQuery" /> to build on.</param>
  1319. <param name="propertyName">The name of the property to filter on.</param>
  1320. </member>
  1321. <member name="M:Xamarin.UITest.Queries.PropertyAppQuery.StartsWith(System.String)">
  1322. <summary>
  1323. Matches properties starting with the given text.
  1324. </summary>
  1325. <param name="text">The text to match.</param>
  1326. </member>
  1327. <member name="M:Xamarin.UITest.Queries.PropertyAppQuery.EndsWith(System.String)">
  1328. <summary>
  1329. Matches properties ending with the given text.
  1330. </summary>
  1331. <param name="text">The text to match.</param>
  1332. </member>
  1333. <member name="M:Xamarin.UITest.Queries.PropertyAppQuery.Contains(System.String)">
  1334. <summary>
  1335. Matches properties containing with the given text.
  1336. </summary>
  1337. <param name="text">The text to match.</param>
  1338. </member>
  1339. <member name="M:Xamarin.UITest.Queries.PropertyAppQuery.Like(System.String)">
  1340. <summary>
  1341. Matches properties like the given text. Supports * wildcards.
  1342. </summary>
  1343. <param name="text">The text to match.</param>
  1344. </member>
  1345. <member name="M:Xamarin.UITest.Queries.PropertyAppQuery.Predicate(System.String,System.String)">
  1346. <summary>
  1347. Matches properties matching the given predicate and text. Allows using unexposed Calabash predicates.
  1348. </summary>
  1349. <param name="predicate">The Calabash predicate to use.</param>
  1350. <param name="text">The text to match.</param>
  1351. </member>
  1352. <member name="M:Xamarin.UITest.Queries.PropertyAppQuery.Value``1">
  1353. <summary>
  1354. Extracts the value of the property.
  1355. </summary>
  1356. <typeparam name="T">The expected result type of the property.</typeparam>
  1357. </member>
  1358. <member name="P:Xamarin.UITest.Queries.PropertyAppQuery.QueryPlatform">
  1359. <summary>
  1360. The target platform of the query. Useful when writing extensions methods for queries for platform differences.
  1361. </summary>
  1362. </member>
  1363. <member name="T:Xamarin.UITest.iOS.iOSApp">
  1364. <summary>
  1365. Represents a running iOS application.
  1366. </summary>
  1367. </member>
  1368. <member name="M:Xamarin.UITest.iOS.iOSApp.#ctor(Xamarin.UITest.Configuration.IiOSAppConfiguration)">
  1369. <summary>
  1370. Main entry point for creating iOS applications. Should not be called directly
  1371. but instead be invoked through the use of <see cref="T:Xamarin.UITest.ConfigureApp" />.
  1372. </summary>
  1373. <param name="appConfiguration">The app configuration. Should be generated from <see cref="T:Xamarin.UITest.ConfigureApp" />.</param>
  1374. </member>
  1375. <member name="M:Xamarin.UITest.iOS.iOSApp.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  1376. <summary>
  1377. Queries view objects using the fluent API. Defaults to only return view objects that are visible.
  1378. </summary>
  1379. <param name="query">Entry point for the fluent API to specify the element. If left as <c>null</c> returns all visible view objects.</param>
  1380. <returns>An array representing the matched view objects.</returns>
  1381. </member>
  1382. <member name="M:Xamarin.UITest.iOS.iOSApp.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery})">
  1383. <summary>
  1384. Queries web view objects using the fluent API. Defaults to only return view objects that are visible.
  1385. </summary>
  1386. <param name="query">Entry point for the fluent API to specify the element. If left as <c>null</c> returns all visible view objects.</param>
  1387. <returns>An array representing the matched view objects.</returns>
  1388. </member>
  1389. <member name="M:Xamarin.UITest.iOS.iOSApp.Query``1(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppTypedSelector{``0}})">
  1390. <summary>
  1391. Queries properties on view objects using the fluent API.
  1392. </summary>
  1393. <param name="query">Entry point for the fluent API to specify the type of the property.</param>
  1394. <typeparam name="T">The type of the property.</typeparam>
  1395. </member>
  1396. <member name="M:Xamarin.UITest.iOS.iOSApp.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.InvokeJSAppQuery})">
  1397. <summary>
  1398. Queries view objects using the fluent API. Defaults to only return view objects that are visible.
  1399. </summary>
  1400. <param name="query">Entry point for the fluent API to specify the element. If left as <c>null</c> returns all visible view objects.</param>
  1401. <returns>An array representing the matched view objects.</returns>
  1402. </member>
  1403. <member name="M:Xamarin.UITest.iOS.iOSApp.Flash(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  1404. <summary>
  1405. Highlights the results of the query by making them flash. Specify view elements using the fluent API. Defaults to all view objects that are visible.
  1406. </summary>
  1407. <param name="query">Entry point for the fluent API to specify the elements. If left as <c>null</c> flashes all visible view objects.</param>
  1408. <returns>An array representing the matched view objects.</returns>
  1409. </member>
  1410. <member name="M:Xamarin.UITest.iOS.iOSApp.EnterText(System.String)">
  1411. <summary>
  1412. Enters text into the currently focused element. Will fail if no keyboard is visible.
  1413. </summary>
  1414. <param name="text">The text to enter.</param>
  1415. </member>
  1416. <member name="M:Xamarin.UITest.iOS.iOSApp.EnterText(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.String)">
  1417. <summary>
  1418. Enters text into a matching element that supports it.
  1419. </summary>
  1420. <param name="query">Entry point for the fluent API to specify the element.</param>
  1421. <param name="text">The text to enter.</param>
  1422. </member>
  1423. <member name="M:Xamarin.UITest.iOS.iOSApp.EnterText(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String)">
  1424. <summary>
  1425. Enters text into a matching element that supports it.
  1426. </summary>
  1427. <param name="query">Entry point for the fluent API to specify the element.</param>
  1428. <param name="text">The text to enter.</param>
  1429. </member>
  1430. <member name="M:Xamarin.UITest.iOS.iOSApp.ClearText(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  1431. <summary>
  1432. Clears text from a matching element that supports it.
  1433. </summary>
  1434. <param name="query">Entry point for the fluent API to specify the element.</param>
  1435. </member>
  1436. <member name="M:Xamarin.UITest.iOS.iOSApp.ClearText">
  1437. <summary>
  1438. Clears text from the currently focused element.
  1439. </summary>
  1440. </member>
  1441. <member name="M:Xamarin.UITest.iOS.iOSApp.PressEnter">
  1442. <summary>
  1443. Presses the enter key in the app.
  1444. </summary>
  1445. </member>
  1446. <member name="M:Xamarin.UITest.iOS.iOSApp.SetOrientationPortrait">
  1447. <summary>
  1448. Changes the device orientation to portrait mode.
  1449. </summary>
  1450. </member>
  1451. <member name="M:Xamarin.UITest.iOS.iOSApp.SetOrientationLandscape">
  1452. <summary>
  1453. Changes the device orientation to landscape mode.
  1454. </summary>
  1455. </member>
  1456. <member name="M:Xamarin.UITest.iOS.iOSApp.Tap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  1457. <summary>
  1458. Performs a tap / touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  1459. </summary>
  1460. <param name="query">Entry point for the fluent API to specify the element.</param>
  1461. </member>
  1462. <member name="M:Xamarin.UITest.iOS.iOSApp.Tap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery})">
  1463. <summary>
  1464. Performs a tap / touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  1465. </summary>
  1466. <param name="query">Entry point for the fluent API to specify the element.</param>
  1467. </member>
  1468. <member name="M:Xamarin.UITest.iOS.iOSApp.TapCoordinates(System.Single,System.Single)">
  1469. <summary>
  1470. Performs a tap / touch gesture on the given coordinates.
  1471. </summary>
  1472. <param name="x">The x coordinate to tap.</param>
  1473. <param name="y">The y coordinate to tap.</param>
  1474. </member>
  1475. <member name="M:Xamarin.UITest.iOS.iOSApp.SwipeRight">
  1476. <summary>
  1477. Performs a right to left swipe gesture.
  1478. </summary>
  1479. </member>
  1480. <member name="M:Xamarin.UITest.iOS.iOSApp.SwipeLeft">
  1481. <summary>
  1482. Performs a left to right swipe gesture.
  1483. </summary>
  1484. </member>
  1485. <member name="M:Xamarin.UITest.iOS.iOSApp.SwipeRight(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  1486. <summary>
  1487. Performs a right to left swipe gesture on the matching element. If multiple elements are matched, the first one will be used.
  1488. </summary>
  1489. <param name="query">Entry point for the fluent API to specify the element.</param>
  1490. </member>
  1491. <member name="M:Xamarin.UITest.iOS.iOSApp.SwipeLeft(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  1492. <summary>
  1493. Performs a left to right swipe gesture on the matching element. If multiple elements are matched, the first one will be used.
  1494. </summary>
  1495. <param name="query">Entry point for the fluent API to specify the element.</param>
  1496. </member>
  1497. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  1498. <summary>
  1499. Scroll until an element that mactches the <c>toMarked</c> is shown on the screen.
  1500. </summary>
  1501. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1502. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1503. <param name="strategy">Strategy for scrolling element.</param>
  1504. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1505. </member>
  1506. <member name="M:Xamarin.UITest.iOS.iOSApp.TouchAndHold(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  1507. <summary>
  1508. Performs a continuous touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  1509. </summary>
  1510. <param name="query">Entry point for the fluent API to specify the element.</param>
  1511. </member>
  1512. <member name="M:Xamarin.UITest.iOS.iOSApp.TouchAndHoldCoordinates(System.Single,System.Single)">
  1513. <summary>
  1514. Performs a continuous touch gesture on the given coordinates.
  1515. </summary>
  1516. <param name="x">The x coordinate to touch.</param>
  1517. <param name="y">The y coordinate to touch.</param>
  1518. </member>
  1519. <member name="M:Xamarin.UITest.iOS.iOSApp.DoubleTap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  1520. <summary>
  1521. Performs two quick tap / touch gestures on the matched element. If multiple elements are matched, the first one will be used.
  1522. </summary>
  1523. <param name="query">Entry point for the fluent API to specify the element.</param>
  1524. </member>
  1525. <member name="M:Xamarin.UITest.iOS.iOSApp.DoubleTapCoordinates(System.Single,System.Single)">
  1526. <summary>
  1527. Performs a quick double tap / touch gesture on the given coordinates.
  1528. </summary>
  1529. <param name="x">The x coordinate to touch.</param>
  1530. <param name="y">The y coordinate to touch.</param>
  1531. </member>
  1532. <member name="M:Xamarin.UITest.iOS.iOSApp.TwoFingerTap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  1533. <summary>
  1534. Performs a tap / touch gestures with 2 fingers on the matched element. If multiple elements are matched, the first one will be used.
  1535. </summary>
  1536. <param name="query">Entry point for the fluent API to specify the element.</param>
  1537. </member>
  1538. <member name="M:Xamarin.UITest.iOS.iOSApp.TwoFingerTapCoordinates(System.Single,System.Single)">
  1539. <summary>
  1540. Performs a tap / touch gesture with 2 fingers on the given coordinates.
  1541. </summary>
  1542. <param name="x">The x coordinate to touch.</param>
  1543. <param name="y">The y coordinate to touch.</param>
  1544. </member>
  1545. <member name="M:Xamarin.UITest.iOS.iOSApp.FlickCoordinates(System.Single,System.Single,System.Single,System.Single)">
  1546. <summary>
  1547. Performs a quick continuous flick gesture between 2 points.
  1548. </summary>
  1549. <param name="fromX">The x coordinate to start from.</param>
  1550. <param name="fromY">The y coordinate to start from.</param>
  1551. <param name="toX">The x coordinate to end at.</param>
  1552. <param name="toY">The y coordinate to end at.</param>
  1553. </member>
  1554. <member name="M:Xamarin.UITest.iOS.iOSApp.DragCoordinates(System.Single,System.Single,System.Single,System.Single)">
  1555. <summary>
  1556. Performs a continuous drag gesture between 2 points.
  1557. </summary>
  1558. <param name="fromX">The x coordinate to start from.</param>
  1559. <param name="fromY">The y coordinate to start from.</param>
  1560. <param name="toX">The x coordinate to end at.</param>
  1561. <param name="toY">The y coordinate to end at.</param>
  1562. </member>
  1563. <member name="M:Xamarin.UITest.iOS.iOSApp.DragCoordinates(System.Single,System.Single,System.Single,System.Single,System.Nullable{System.TimeSpan})">
  1564. <summary>
  1565. Performs a continuous drag gesture between 2 points.
  1566. </summary>
  1567. <param name="fromX">The x coordinate to start from.</param>
  1568. <param name="fromY">The y coordinate to start from.</param>
  1569. <param name="toX">The x coordinate to end at.</param>
  1570. <param name="toY">The y coordinate to end at.</param>
  1571. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pan gesture.</param>
  1572. </member>
  1573. <member name="M:Xamarin.UITest.iOS.iOSApp.PinchToZoomIn(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Nullable{System.TimeSpan})">
  1574. <summary>
  1575. Performs a pinch gestures on the matched element to zoom the view in. If multiple elements are matched, the first one will be used.
  1576. </summary>
  1577. <param name="query">Entry point for the fluent API to specify the element.</param>
  1578. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  1579. </member>
  1580. <member name="M:Xamarin.UITest.iOS.iOSApp.PinchToZoomInCoordinates(System.Single,System.Single,System.Nullable{System.TimeSpan})">
  1581. <summary>
  1582. Performs a pinch gestures to zoom the view in on the given coordinates.
  1583. </summary>
  1584. <param name="x">The x coordinate of the center of the pinch.</param>
  1585. <param name="y">The y coordinate of the center of the pinch.</param>
  1586. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  1587. </member>
  1588. <member name="M:Xamarin.UITest.iOS.iOSApp.PinchToZoomOut(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Nullable{System.TimeSpan})">
  1589. <summary>
  1590. Performs a pinch gestures on the matched element to zoom the view out. If multiple elements are matched, the first one will be used.
  1591. </summary>
  1592. <param name="query">Entry point for the fluent API to specify the element.</param>
  1593. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  1594. </member>
  1595. <member name="M:Xamarin.UITest.iOS.iOSApp.PinchToZoomOutCoordinates(System.Single,System.Single,System.Nullable{System.TimeSpan})">
  1596. <summary>
  1597. Performs a pinch gestures to zoom the view in on the given coordinates.
  1598. </summary>
  1599. <param name="x">The x coordinate of the center of the pinch.</param>
  1600. <param name="y">The y coordinate of the center of the pinch.</param>
  1601. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  1602. </member>
  1603. <member name="M:Xamarin.UITest.iOS.iOSApp.DismissKeyboard">
  1604. <summary>
  1605. Dismisses the keyboard if present
  1606. </summary>
  1607. </member>
  1608. <member name="M:Xamarin.UITest.iOS.iOSApp.PressVolumeUp">
  1609. <summary>
  1610. Presses the volume up button on the device.
  1611. </summary>
  1612. </member>
  1613. <member name="M:Xamarin.UITest.iOS.iOSApp.PressVolumeDown">
  1614. <summary>
  1615. Presses the volume down button on the device.
  1616. </summary>
  1617. </member>
  1618. <member name="M:Xamarin.UITest.iOS.iOSApp.SendAppToBackground(System.TimeSpan)">
  1619. <summary>
  1620. Sends the app to background for the specified time span.
  1621. </summary>
  1622. <param name="time">The time for the app to be in the background.</param>
  1623. </member>
  1624. <member name="M:Xamarin.UITest.iOS.iOSApp.WaitFor(System.Func{System.Boolean},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  1625. <summary>
  1626. Generic wait function that will repeatly call the <c>predicate</c> function until it returns <c>true</c>. Throws a <see cref="T:System.TimeoutException" /> if the predicate is not fullfilled within the time limit.
  1627. </summary>
  1628. <param name="predicate">Predicate function that should return <c>true</c> when waiting is complete.</param>
  1629. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  1630. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1631. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each call to the predicate.</param>
  1632. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the predicate returns <c>true</c>.</param>
  1633. </member>
  1634. <member name="M:Xamarin.UITest.iOS.iOSApp.WaitForElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  1635. <summary>
  1636. Wait function that will repeatly query the app until a matching element is found. Throws a <see cref="T:System.TimeoutException" /> if no element is found within the time limit.
  1637. </summary>
  1638. <param name="query">Entry point for the fluent API to specify the element.</param>
  1639. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  1640. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1641. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  1642. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element has been found.</param>
  1643. <returns>An array representing the matched view objects.</returns>
  1644. </member>
  1645. <member name="M:Xamarin.UITest.iOS.iOSApp.WaitForNoElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  1646. <summary>
  1647. Wait function that will repeatly query the app until a matching element is no longer found. Throws a <see cref="T:System.TimeoutException" /> if the element is visible at the end of the time limit.
  1648. </summary>
  1649. <param name="query">Entry point for the fluent API to specify the element.</param>
  1650. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  1651. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1652. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  1653. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element is no longer visible.</param>
  1654. </member>
  1655. <member name="M:Xamarin.UITest.iOS.iOSApp.WaitForElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  1656. <summary>
  1657. Wait function that will repeatly query the app until a matching element is found. Throws a <see cref="T:System.TimeoutException" /> if no element is found within the time limit.
  1658. </summary>
  1659. <param name="query">Entry point for the fluent API to specify the element.</param>
  1660. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  1661. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1662. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  1663. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element has been found.</param>
  1664. <returns>An array representing the matched view objects.</returns>
  1665. </member>
  1666. <member name="M:Xamarin.UITest.iOS.iOSApp.WaitForNoElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  1667. <summary>
  1668. Wait function that will repeatly query the app until a matching element is no longer found. Throws a <see cref="T:System.TimeoutException" /> if the element is visible at the end of the time limit.
  1669. </summary>
  1670. <param name="query">Entry point for the fluent API to specify the element.</param>
  1671. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  1672. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1673. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  1674. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element is no longer visible.</param>
  1675. </member>
  1676. <member name="M:Xamarin.UITest.iOS.iOSApp.Screenshot(System.String)">
  1677. <summary>
  1678. Takes a screenshot of the app in it's current state. This is used to denote test steps in the Xamarin Test Cloud.
  1679. </summary>
  1680. <param name="title">The title of screenshot, used as step name.</param>
  1681. <returns>The screenshot file.</returns>
  1682. </member>
  1683. <member name="P:Xamarin.UITest.iOS.iOSApp.Print">
  1684. <summary>
  1685. Contains helper methods for outputting the result of queries instead of resorting to <see cref="T:System.Console" />.
  1686. </summary>
  1687. </member>
  1688. <member name="M:Xamarin.UITest.iOS.iOSApp.Repl">
  1689. <summary>
  1690. Starts an interactive REPL (Read-Eval-Print-Loop) for app exploration and pauses test execution until it is closed.
  1691. </summary>
  1692. </member>
  1693. <member name="M:Xamarin.UITest.iOS.iOSApp.Invoke(System.String,System.Object)">
  1694. <summary>
  1695. Invokes a method on the app's app delegate. For Xamarin apps, methods must be exposed using attributes as shown below.
  1696. iOS example in app delegate:
  1697. <code>
  1698. [Export("myInvokeMethod:")]
  1699. public NSString MyInvokeMethod(NSString arg)
  1700. {
  1701. return new NSString("uitest");
  1702. }
  1703. </code></summary>
  1704. <param name="methodName">The name of the method to invoke.</param>
  1705. <param name="argument">The argument to pass to the method.</param>
  1706. <returns>The result of the invocation.</returns>
  1707. </member>
  1708. <member name="M:Xamarin.UITest.iOS.iOSApp.InvokeUia(System.String)">
  1709. <summary>
  1710. Invokes raw UIA javascript.
  1711. </summary>
  1712. <param name="script">The automation script.</param>
  1713. <returns>The result of the script.</returns>
  1714. </member>
  1715. <member name="P:Xamarin.UITest.iOS.iOSApp.Config">
  1716. <summary>
  1717. Obsolete, use Device instead.
  1718. Contains runtime information about the currently running device.
  1719. </summary>
  1720. </member>
  1721. <member name="P:Xamarin.UITest.iOS.iOSApp.Xamarin#UITest#IApp#Device">
  1722. <summary>
  1723. Runtime information and control of the currently running device.
  1724. </summary>
  1725. </member>
  1726. <member name="M:Xamarin.UITest.iOS.iOSApp.Back">
  1727. <summary>
  1728. Navigate back on the device.
  1729. </summary>
  1730. </member>
  1731. <member name="P:Xamarin.UITest.iOS.iOSApp.TestServer">
  1732. <summary>
  1733. Allows HTTP access to the test server running on the device.
  1734. </summary>
  1735. </member>
  1736. <member name="P:Xamarin.UITest.iOS.iOSApp.Device">
  1737. <summary>
  1738. Runtime information and control of the currently running device.
  1739. </summary>
  1740. </member>
  1741. <member name="M:Xamarin.UITest.iOS.iOSApp.Query(System.String)">
  1742. <summary>
  1743. Queries view objects using the fluent API. Defaults to only return view objects that are visible.
  1744. </summary>
  1745. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1746. <returns>An array representing the matched view objects.</returns>
  1747. </member>
  1748. <member name="M:Xamarin.UITest.iOS.iOSApp.Flash(System.String)">
  1749. <summary>
  1750. Highlights the results of the query by making them flash. Specify view elements using marked string.
  1751. </summary>
  1752. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1753. <returns>An array representing the matched view objects.</returns>
  1754. </member>
  1755. <member name="M:Xamarin.UITest.iOS.iOSApp.EnterText(System.String,System.String)">
  1756. <summary>
  1757. Enters text into a matching element that supports it.
  1758. </summary>
  1759. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1760. <param name="text">The text to enter.</param>
  1761. </member>
  1762. <member name="M:Xamarin.UITest.iOS.iOSApp.ClearText(System.String)">
  1763. <summary>
  1764. Clears text from a matching element that supports it.
  1765. </summary>
  1766. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1767. </member>
  1768. <member name="M:Xamarin.UITest.iOS.iOSApp.Tap(System.String)">
  1769. <summary>
  1770. Performs a tap / touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  1771. </summary>
  1772. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1773. </member>
  1774. <member name="M:Xamarin.UITest.iOS.iOSApp.TouchAndHold(System.String)">
  1775. <summary>
  1776. Performs a continuous touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  1777. </summary>
  1778. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1779. </member>
  1780. <member name="M:Xamarin.UITest.iOS.iOSApp.DoubleTap(System.String)">
  1781. <summary>
  1782. Performs two quick tap / touch gestures on the matched element. If multiple elements are matched, the first one will be used.
  1783. </summary>
  1784. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1785. </member>
  1786. <member name="M:Xamarin.UITest.iOS.iOSApp.PinchToZoomIn(System.String,System.Nullable{System.TimeSpan})">
  1787. <summary>
  1788. Performs a pinch gestures on the matched element to zoom the view in. If multiple elements are matched, the first one will be used.
  1789. </summary>
  1790. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1791. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  1792. </member>
  1793. <member name="M:Xamarin.UITest.iOS.iOSApp.PinchToZoomOut(System.String,System.Nullable{System.TimeSpan})">
  1794. <summary>
  1795. Performs a pinch gestures on the matched element to zoom the view out. If multiple elements are matched, the first one will be used.
  1796. </summary>
  1797. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1798. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  1799. </member>
  1800. <member name="M:Xamarin.UITest.iOS.iOSApp.WaitForNoElement(System.String,System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  1801. <summary>
  1802. Wait function that will repeatly query the app until a matching element is no longer found. Throws a <see cref="T:System.TimeoutException" /> if the element is visible at the end of the time limit.
  1803. </summary>
  1804. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1805. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  1806. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1807. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  1808. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element is no longer visible.</param>
  1809. </member>
  1810. <member name="M:Xamarin.UITest.iOS.iOSApp.WaitForElement(System.String,System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  1811. <summary>
  1812. Wait function that will repeatly query the app until a matching element is found. Throws a <see cref="T:System.TimeoutException" /> if no element is found within the time limit.
  1813. </summary>
  1814. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1815. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  1816. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1817. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  1818. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element has been found.</param>
  1819. <returns>An array representing the matched view objects.</returns>
  1820. </member>
  1821. <member name="M:Xamarin.UITest.iOS.iOSApp.SwipeRight(System.String)">
  1822. <summary>
  1823. Performs a right to left swipe gesture on the matching element. If multiple elements are matched, the first one will be used.
  1824. </summary>
  1825. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1826. </member>
  1827. <member name="M:Xamarin.UITest.iOS.iOSApp.SwipeLeft(System.String)">
  1828. <summary>
  1829. Performs a left to right swipe gesture on the matching element. If multiple elements are matched, the first one will be used.
  1830. </summary>
  1831. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1832. </member>
  1833. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollUp(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy)">
  1834. <summary>
  1835. Scrolls up on the first element matching query.
  1836. </summary>
  1837. <param name="withinQuery">Entry point for the fluent API to specify the what element to scroll within.</param>
  1838. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1839. </member>
  1840. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollUp(System.String,Xamarin.UITest.ScrollStrategy)">
  1841. <summary>
  1842. Scrolls up on the first element matching query.
  1843. </summary>
  1844. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1845. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1846. </member>
  1847. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollDown(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy)">
  1848. <summary>
  1849. Scrolls down on the first element matching query.
  1850. </summary>
  1851. <param name="withinQuery">Entry point for the fluent API to specify the what element to scroll within.</param>
  1852. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1853. </member>
  1854. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollDown(System.String,Xamarin.UITest.ScrollStrategy)">
  1855. <summary>
  1856. Scrolls down on the first element matching query.
  1857. </summary>
  1858. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1859. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1860. </member>
  1861. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollUpTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  1862. <summary>
  1863. Scroll up until an element that mactches the <c>toQuery</c> is shown on the screen.
  1864. </summary>
  1865. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  1866. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  1867. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1868. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1869. </member>
  1870. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollUpTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  1871. <summary>
  1872. Scroll up until an element that mactches the <c>toQuery</c> is shown on the screen.
  1873. </summary>
  1874. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  1875. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  1876. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1877. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1878. </member>
  1879. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollUpTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  1880. <summary>
  1881. Scroll up until an element that mactches the <c>toMarked</c> is shown on the screen.
  1882. </summary>
  1883. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  1884. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1885. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1886. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1887. </member>
  1888. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollUpTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  1889. <summary>
  1890. Scroll up until an element that mactches the <c>toMarked</c> is shown on the screen.
  1891. </summary>
  1892. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1893. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1894. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1895. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1896. </member>
  1897. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollDownTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  1898. <summary>
  1899. Scroll down until an element that mactches the <c>toQuery</c> is shown on the screen.
  1900. </summary>
  1901. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  1902. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  1903. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1904. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1905. </member>
  1906. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollDownTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  1907. <summary>
  1908. Scroll down until an element that mactches the <c>toQuery</c> is shown on the screen.
  1909. </summary>
  1910. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  1911. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  1912. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1913. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1914. </member>
  1915. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollDownTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  1916. <summary>
  1917. Scroll down until an element that mactches the <c>toMarked</c> is shown on the screen.
  1918. </summary>
  1919. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  1920. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1921. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1922. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1923. </member>
  1924. <member name="M:Xamarin.UITest.iOS.iOSApp.ScrollDownTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  1925. <summary>
  1926. Scroll down until an element that mactches the <c>toMarked</c> is shown on the screen.
  1927. </summary>
  1928. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1929. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1930. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  1931. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  1932. </member>
  1933. <member name="M:Xamarin.UITest.iOS.iOSApp.TwoFingerTap(System.String)">
  1934. <summary>
  1935. Performs a tap / touch gestures with 2 fingers on the matched element. If multiple elements are matched, the first one will be used.
  1936. </summary>
  1937. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  1938. </member>
  1939. <member name="T:Xamarin.UITest.Configuration.iOSAppConfigurator">
  1940. <summary>
  1941. Represents the iOS specific part of the <see cref="T:Xamarin.UITest.ConfigureApp" /> fluent API. Should not be used directly.
  1942. </summary>
  1943. </member>
  1944. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.#ctor(Xamarin.UITest.Configuration.GenericAppConfigurator)">
  1945. <summary>
  1946. Part of the <see cref="T:Xamarin.UITest.ConfigureApp" /> fluent API. Should not be used directly.
  1947. </summary>
  1948. </member>
  1949. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.Debug">
  1950. <summary>
  1951. Enables debug logging from the test runner.
  1952. </summary>
  1953. </member>
  1954. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.ApiKey(System.String)">
  1955. <summary>
  1956. Sets the Xamarin Test Cloud api key to use for activation. This can also be set using:
  1957. * An <see cref="T:Xamarin.UITest.TestCloudApiKeyAttribute" /> in Properties/AssemblyInfo.cs.
  1958. * Setting an environment variable named XTC_API_KEY
  1959. * Creating a file named xtc-api-key in any upstream directory from the test
  1960. </summary>
  1961. <param name="apiKey">The Xamarin Test Cloud api key.</param>
  1962. </member>
  1963. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.EnableLocalScreenshots">
  1964. <summary>
  1965. Enables local screenshot saving. Always enabled in the cloud.
  1966. </summary>
  1967. </member>
  1968. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.PreferIdeSettings">
  1969. <summary>
  1970. Always uses settings from IDE if they're present, overriding other configured values.
  1971. If not set, explicit configuration will disable IDE integration.
  1972. </summary>
  1973. </member>
  1974. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.DeviceIp(System.String)">
  1975. <summary>
  1976. Configures the ip address of the device. Generally best left unset unless you are
  1977. running an iOS application on a physical device.
  1978. </summary>
  1979. <param name="ipAddress">The ip address of the device.</param>
  1980. </member>
  1981. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.DevicePort(System.Int32)">
  1982. <summary>
  1983. Configures the port of the device. Generally best left unset.
  1984. </summary>
  1985. <param name="port">The port of the Calabash HTTP server on the device.</param>
  1986. </member>
  1987. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.LogDirectory(System.String)">
  1988. <summary>
  1989. Sets the directory to store local log files in
  1990. </summary>
  1991. <param name="directory">The full path of the directory to store local log files in</param>
  1992. </member>
  1993. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.DisableSpecFlowIntegration">
  1994. <summary>
  1995. Disables automatic screenshot generation after each SpecFlow step.
  1996. </summary>
  1997. </member>
  1998. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.AppBundle(System.String)">
  1999. <summary>
  2000. Configures the app bundle to use. Will force a run on simulator.
  2001. </summary>
  2002. <param name="path">Path to the directory containing the app bundle.</param>
  2003. </member>
  2004. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.AppBundleZip(System.String)">
  2005. <summary>
  2006. Configures the zipped app bundle to use. Will force a run on simulator.
  2007. </summary>
  2008. <param name="path">Path to the directory containing the zipped app bundle.</param>
  2009. </member>
  2010. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.InstalledApp(System.String)">
  2011. <summary>
  2012. Configures the installed app to use. Will force a run on physical device.
  2013. </summary>
  2014. <param name="bundleId">The bundle id of the installed application.</param>
  2015. </member>
  2016. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.DeviceIdentifier(System.String)">
  2017. <summary>
  2018. Configures the device to use with the device identifier (UUID).
  2019. </summary>
  2020. <param name="deviceIdentifier">The device identifier (UUID) found in the XCode Organizer.</param>
  2021. </member>
  2022. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.WaitTimes(Xamarin.UITest.Utils.IWaitTimes)">
  2023. <summary>
  2024. Configures the default wait times for the framework.
  2025. </summary>
  2026. <param name="waitTimes">An implementation providing defaults.</param>
  2027. </member>
  2028. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.StartApp(Xamarin.UITest.Configuration.AppDataMode)">
  2029. <summary>
  2030. Builds the configuration and launches the app on the selected device or simulator.
  2031. </summary>
  2032. <param name="appDataMode">The app data mode. Whether to clear app data or not before app launch. Currently only supported in Xamarin Test Cloud.</param>
  2033. <returns>The <see cref="T:Xamarin.UITest.iOS.iOSApp" /> to use in the tests.</returns>
  2034. </member>
  2035. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.ConnectToApp">
  2036. <summary>
  2037. Builds the configuration and connects to an already running app.
  2038. Used for advanced scenarios. Regular users should use <see cref="M:Xamarin.UITest.Configuration.iOSAppConfigurator.StartApp(Xamarin.UITest.Configuration.AppDataMode)" />
  2039. instead.
  2040. </summary>
  2041. <returns>The <see cref="T:Xamarin.UITest.iOS.iOSApp" /> to use in the tests.</returns>
  2042. </member>
  2043. <member name="M:Xamarin.UITest.Configuration.iOSAppConfigurator.GetConfiguration(Xamarin.UITest.Configuration.StartAction,Xamarin.UITest.Configuration.AppDataMode)">
  2044. <summary>
  2045. Builds the iOS app configuration which can be used for input for <see cref="T:Xamarin.UITest.iOS.iOSApp" />.
  2046. The <see cref="M:Xamarin.UITest.Configuration.iOSAppConfigurator.StartApp(Xamarin.UITest.Configuration.AppDataMode)" /> and <see cref="M:Xamarin.UITest.Configuration.iOSAppConfigurator.ConnectToApp" /> methods should be used instead unless
  2047. you have specific needs for the configuration.
  2048. </summary>
  2049. <param name="startAction">The start action for the configuration. See <see cref="M:Xamarin.UITest.Configuration.iOSAppConfigurator.StartApp(Xamarin.UITest.Configuration.AppDataMode)" /> and <see cref="M:Xamarin.UITest.Configuration.iOSAppConfigurator.ConnectToApp" /> methods.</param>
  2050. <param name="appDataMode">The app data mode. Whether to clear app data or not before app launch. Currently only supported in Xamarin Test Cloud.</param>
  2051. <returns>An <see cref="T:Xamarin.UITest.Configuration.IiOSAppConfiguration" /> which can used for input for <see cref="T:Xamarin.UITest.iOS.iOSApp" />.</returns>
  2052. </member>
  2053. <member name="T:Xamarin.UITest.Configuration.AndroidAppConfigurator">
  2054. <summary>
  2055. Represents the Android specific part of the <see cref="T:Xamarin.UITest.ConfigureApp" /> fluent API. Should not be used directly.
  2056. </summary>
  2057. </member>
  2058. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.#ctor(Xamarin.UITest.Configuration.GenericAppConfigurator)">
  2059. <summary>
  2060. Part of the <see cref="T:Xamarin.UITest.ConfigureApp" /> fluent API. Should not be used directly.
  2061. </summary>
  2062. </member>
  2063. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.Debug">
  2064. <summary>
  2065. Enables debug logging from the test runner.
  2066. </summary>
  2067. </member>
  2068. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.EnableLocalScreenshots">
  2069. <summary>
  2070. Enables local screenshot saving. Always enabled in the cloud.
  2071. </summary>
  2072. </member>
  2073. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.PreferIdeSettings">
  2074. <summary>
  2075. Always uses settings from IDE if they're present, overriding other configured values.
  2076. If not set, explicit configuration will disable IDE integration.
  2077. </summary>
  2078. </member>
  2079. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.DisableSpecFlowIntegration">
  2080. <summary>
  2081. Disables automatic screenshot generation after each SpecFlow step.
  2082. </summary>
  2083. </member>
  2084. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.DeviceIp(System.String)">
  2085. <summary>
  2086. Configures the ip address of the device. Generally best left unset unless you are
  2087. running an iOS application on a physical device.
  2088. </summary>
  2089. <param name="ipAddress">The ip address of the device.</param>
  2090. </member>
  2091. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.DevicePort(System.Int32)">
  2092. <summary>
  2093. Configures the port of the device. Generally best left unset.
  2094. </summary>
  2095. <param name="port">The port of the Calabash HTTP server on the device.</param>
  2096. </member>
  2097. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.ApiKey(System.String)">
  2098. <summary>
  2099. Sets the Xamarin Test Cloud api key to use for activation. This can also be set using:
  2100. * An <see cref="T:Xamarin.UITest.TestCloudApiKeyAttribute" /> in Properties/AssemblyInfo.cs.
  2101. * Setting an environment variable named XTC_API_KEY
  2102. * Creating a file named xtc-api-key in any upstream directory from the test
  2103. </summary>
  2104. <param name="apiKey">The Xamarin Test Cloud api key.</param>
  2105. </member>
  2106. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.LogDirectory(System.String)">
  2107. <summary>
  2108. Sets the directory to store local log files in
  2109. </summary>
  2110. <param name="directory">The full path of the directory to store local log files in</param>
  2111. </member>
  2112. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.DeviceSerial(System.String)">
  2113. <summary>
  2114. Configures the adb serial of the device. Generally best left unset unless you want to run a specific device.
  2115. </summary>
  2116. <param name="deviceSerial">The device serial from adb devices.</param>
  2117. </member>
  2118. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.KeyStore(System.String,System.String,System.String,System.String)">
  2119. <summary>
  2120. Configures the keystore that the provided apk file is signed with.
  2121. A keystore is not required, but will ensure that the apk file is pristine and unchanged.
  2122. If a keystore is provided, it will be used to sign the auxiliary apks installed along with the app on the device.
  2123. If a keystore is not provided, Xamarin.UITest will generate a keystore and resign the apk.
  2124. </summary>
  2125. <param name="path">Path to the keystore file.</param>
  2126. <param name="storePassword">Password to the keystore. Corresponds to the <c>-storepass</c> argument in jarsigner.</param>
  2127. <param name="keyPassword">Password to the matching private key in the keystore. Corresponds to the <c>-keypass</c> argument in jarsigner.</param>
  2128. <param name="keyAlias">Alias to the key in the keystore. Corresponds to the <c>alias</c> argument in jarsigner.</param>
  2129. </member>
  2130. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.SigningInfoFile(System.String)">
  2131. <summary>
  2132. Configures the signing info file that the test server will be "signed" with.
  2133. A signing info file is not required, but can be used instead of a keystore for signing the test server. The signing info file can be freely shared
  2134. without the risk of leaking keying material.
  2135. The signing info file can be generated using the console tool.
  2136. </summary>
  2137. <param name="path">Path to the signing info file.</param>
  2138. </member>
  2139. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.ApkFile(System.String)">
  2140. <summary>
  2141. Configures the apk file to use.
  2142. </summary>
  2143. <param name="path">Path to the apk file.</param>
  2144. </member>
  2145. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.InstalledApp(System.String)">
  2146. <summary>
  2147. Configures the already installed app to use.
  2148. </summary>
  2149. <param name="packageName">Package name of the installed app.</param>
  2150. </member>
  2151. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.WaitTimes(Xamarin.UITest.Utils.IWaitTimes)">
  2152. <summary>
  2153. Configures the default wait times for the framework.
  2154. </summary>
  2155. <param name="waitTimes">An implementation providing defaults.</param>
  2156. </member>
  2157. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.StartApp(Xamarin.UITest.Configuration.AppDataMode)">
  2158. <summary>
  2159. Builds the configuration and launches the app on the selected device.
  2160. </summary>
  2161. <param name="appDataMode">The app data mode. Whether to clear app data or not before app launch.</param>
  2162. <returns>The <see cref="T:Xamarin.UITest.Android.AndroidApp" /> to use in the tests.</returns>
  2163. </member>
  2164. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.ConnectToApp">
  2165. <summary>
  2166. Builds the configuration and connects to an already running app.
  2167. Used for advanced scenarios. Regular users should use <see cref="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.StartApp(Xamarin.UITest.Configuration.AppDataMode)" />
  2168. instead.
  2169. </summary>
  2170. <returns>The <see cref="T:Xamarin.UITest.Android.AndroidApp" /> to use in the tests.</returns>
  2171. </member>
  2172. <member name="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.GetConfiguration(Xamarin.UITest.Configuration.StartAction,Xamarin.UITest.Configuration.AppDataMode)">
  2173. <summary>
  2174. Builds the Android app configuration which can be used for input for <see cref="T:Xamarin.UITest.Android.AndroidApp" />.
  2175. The <see cref="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.StartApp(Xamarin.UITest.Configuration.AppDataMode)" /> and <see cref="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.ConnectToApp" /> methods should be used instead unless
  2176. you have specific needs for the configuration.
  2177. </summary>
  2178. <param name="startAction">The start action for the configuration. See <see cref="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.StartApp(Xamarin.UITest.Configuration.AppDataMode)" /> and <see cref="M:Xamarin.UITest.Configuration.AndroidAppConfigurator.ConnectToApp" /> methods.</param>
  2179. <param name="appDataMode">The app data mode. Whether to clear app data or not before app launch.</param>
  2180. <returns>An <see cref="T:Xamarin.UITest.Configuration.IAndroidAppConfiguration" /> which can used for input for <see cref="T:Xamarin.UITest.Android.AndroidApp" />.</returns>
  2181. </member>
  2182. <member name="T:Xamarin.UITest.Configuration.GenericAppConfigurator">
  2183. <summary>
  2184. Represents the generic specific part of the <see cref="T:Xamarin.UITest.ConfigureApp" /> fluent API. Should not be used directly.
  2185. </summary>
  2186. </member>
  2187. <member name="M:Xamarin.UITest.Configuration.GenericAppConfigurator.Debug">
  2188. <summary>
  2189. Enables debug logging from the test runner.
  2190. </summary>
  2191. </member>
  2192. <member name="M:Xamarin.UITest.Configuration.GenericAppConfigurator.EnableLocalScreenshots">
  2193. <summary>
  2194. Enables local screenshot saving. Always enabled in the cloud.
  2195. </summary>
  2196. </member>
  2197. <member name="M:Xamarin.UITest.Configuration.GenericAppConfigurator.PreferIdeSettings">
  2198. <summary>
  2199. Always uses settings from IDE if they're present, overriding other configured values.
  2200. If not set, explicit configuration will disable IDE integration.
  2201. </summary>
  2202. </member>
  2203. <member name="P:Xamarin.UITest.Configuration.GenericAppConfigurator.iOS">
  2204. <summary>
  2205. Specifies that the app is an iOS app.
  2206. </summary>
  2207. </member>
  2208. <member name="P:Xamarin.UITest.Configuration.GenericAppConfigurator.Android">
  2209. <summary>
  2210. Specifies that the app is an Android app.
  2211. </summary>
  2212. </member>
  2213. <member name="M:Xamarin.UITest.Configuration.GenericAppConfigurator.ApiKey(System.String)">
  2214. <summary>
  2215. Sets the Xamarin Test Cloud api key to use for activation. This can also be set using:
  2216. * An <see cref="T:Xamarin.UITest.TestCloudApiKeyAttribute" /> in Properties/AssemblyInfo.cs.
  2217. * Setting an environment variable named XTC_API_KEY
  2218. * Creating a file named xtc-api-key in any upstream directory from the test
  2219. </summary>
  2220. <param name="apiKey">The Xamarin Test Cloud api key.</param>
  2221. </member>
  2222. <member name="M:Xamarin.UITest.Configuration.GenericAppConfigurator.DeviceIp(System.String)">
  2223. <summary>
  2224. Configures the ip address of the device. Generally best left unset unless you are
  2225. running an iOS application on a physical device.
  2226. </summary>
  2227. <param name="ipAddress">The ip address of the device.</param>
  2228. </member>
  2229. <member name="M:Xamarin.UITest.Configuration.GenericAppConfigurator.DevicePort(System.Int32)">
  2230. <summary>
  2231. Configures the port of the device. Generally best left unset.
  2232. </summary>
  2233. <param name="port">The port of the Calabash HTTP server on the device.</param>
  2234. </member>
  2235. <member name="M:Xamarin.UITest.Configuration.GenericAppConfigurator.LogDirectory(System.String)">
  2236. <summary>
  2237. Sets the directory to store local log files in
  2238. </summary>
  2239. <param name="directory">The full path of the directory to store local log files in</param>
  2240. </member>
  2241. <member name="M:Xamarin.UITest.Configuration.GenericAppConfigurator.DisableSpecFlowIntegration">
  2242. <summary>
  2243. Disables automatic screenshot generation after each SpecFlow step.
  2244. </summary>
  2245. </member>
  2246. <member name="M:Xamarin.UITest.Configuration.GenericAppConfigurator.GetConfiguration">
  2247. <summary>
  2248. Builds the generic app configuration which contains the shared configuration
  2249. across platforms.
  2250. The <see cref="N:Xamarin.UITest.Android" /> or <see cref="N:Xamarin.UITest.iOS" /> properties should be used
  2251. instead as part of the fluent API unless the configuration is needed.
  2252. </summary>
  2253. <returns>An <see cref="T:Xamarin.UITest.Configuration.IGenericAppConfiguration" /> to be consumed by the
  2254. platform specific configurations.</returns>
  2255. </member>
  2256. <member name="T:Xamarin.UITest.Configuration.IAndroidAppConfiguration">
  2257. <summary>
  2258. Configuration for Android apps. Not to be used directly, should be created by using the fluent <see cref="T:Xamarin.UITest.ConfigureApp" /> API.
  2259. </summary>
  2260. </member>
  2261. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.KeyStore">
  2262. <summary>
  2263. The location of the keystore that was used to sign the tested app. If left empty a new keystore will be built.
  2264. </summary>
  2265. </member>
  2266. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.KeyStorePassword">
  2267. <summary>
  2268. The store password of the given keystore. Corresponds to the <c>-storepass</c> argument in jarsigner.
  2269. </summary>
  2270. </member>
  2271. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.KeyStoreKeyPassword">
  2272. <summary>
  2273. The private key password of the given keystore key. Corresponds to the <c>-keypass</c> argument in jarsigner.
  2274. </summary>
  2275. </member>
  2276. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.KeyStoreKeyAlias">
  2277. <summary>
  2278. The key alias to use for given keystore. Corresponds to the alias argument in jarsigner.
  2279. </summary>
  2280. </member>
  2281. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.SIFile">
  2282. <summary>
  2283. The location of the SI file used for generating the signed test server.
  2284. </summary>
  2285. </member>
  2286. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.ApkFile">
  2287. <summary>
  2288. The location of the apk file to test.
  2289. </summary>
  2290. </member>
  2291. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.InstalledAppPackageName">
  2292. <summary>
  2293. The package name of the installed app.
  2294. </summary>
  2295. </member>
  2296. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.Debug">
  2297. <summary>
  2298. Enable debug logging.
  2299. </summary>
  2300. </member>
  2301. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.ApiKey">
  2302. <summary>
  2303. The Xamarin Test Cloud api key to use for activation.
  2304. </summary>
  2305. </member>
  2306. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.StartAction">
  2307. <summary>
  2308. The desired state of the app after test initialization. Either the test framework can start the app or connect to an already running app in more advanced scenarios.
  2309. </summary>
  2310. </member>
  2311. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.AppDataMode">
  2312. <summary>
  2313. Whether to clear app data or not.
  2314. </summary>
  2315. </member>
  2316. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.DeviceUri">
  2317. <summary>
  2318. The uri of the device test server.
  2319. </summary>
  2320. </member>
  2321. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.ConfiguredDeviceIp">
  2322. <summary>
  2323. The configured ip address. Use <c>DeviceUri</c> for the active configuration.
  2324. </summary>
  2325. <value>The configured ip address.</value>
  2326. </member>
  2327. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.ConfiguredDevicePort">
  2328. <summary>
  2329. The configured port. Use <c>DeviceUri</c> for the active configuration.
  2330. </summary>
  2331. <value>The configured ip address.</value>
  2332. </member>
  2333. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.DeviceSerial">
  2334. <summary>
  2335. The serial of the device. Can be found using adb.
  2336. </summary>
  2337. </member>
  2338. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.EnableScreenshots">
  2339. <summary>
  2340. Enable screenshots. Local screenshots are disabled by default to speed up tests.
  2341. </summary>
  2342. </member>
  2343. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.LaunchableActivity">
  2344. <summary>
  2345. Specify the specific launchable activity to use
  2346. </summary>
  2347. </member>
  2348. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.LogDirectory">
  2349. <summary>
  2350. Specify the location of the log directory for local test runs.
  2351. </summary>
  2352. </member>
  2353. <member name="M:Xamarin.UITest.Configuration.IAndroidAppConfiguration.Verify">
  2354. <summary>
  2355. Verifies the configuration.
  2356. </summary>
  2357. </member>
  2358. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.WaitTimes">
  2359. <summary>
  2360. Default wait times.
  2361. </summary>
  2362. </member>
  2363. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.IdeIntegrationMode">
  2364. <summary>
  2365. The IDE integration mode. Decides what settings to use in case of both explicit configuration and active IDE integration.
  2366. </summary>
  2367. </member>
  2368. <member name="P:Xamarin.UITest.Configuration.IAndroidAppConfiguration.DisableSpecFlowIntegration">
  2369. <summary>
  2370. Whether to disables automatic screenshot generation after each SpecFlow step.
  2371. </summary>
  2372. </member>
  2373. <member name="T:Xamarin.UITest.TestCloudApiKeyAttribute">
  2374. <summary>
  2375. Attribute to set your Xamarin Test Cloud api key for activation.
  2376. Add the following to your <c>Properties/AssemblyInfo.cs</c> file.
  2377. <c>
  2378. [assembly: Xamarin.UITest.TestCloudApiKey(YOUR_API_KEY)]
  2379. </c></summary>
  2380. </member>
  2381. <member name="M:Xamarin.UITest.TestCloudApiKeyAttribute.#ctor(System.String)">
  2382. <summary>
  2383. Creates an instance.
  2384. </summary>
  2385. <param name="apiKey">A Xamarin Test Cloud api key.</param>
  2386. </member>
  2387. <member name="P:Xamarin.UITest.TestCloudApiKeyAttribute.ApiKey">
  2388. <summary>
  2389. The Xamarin Test Cloud api key.
  2390. </summary>
  2391. </member>
  2392. <member name="T:Xamarin.UITest.Queries.AppQuery">
  2393. <summary>
  2394. Fluent query API for specifying view elements to match for queries and gestures.
  2395. </summary>
  2396. </member>
  2397. <member name="M:Xamarin.UITest.Queries.AppQuery.#ctor(Xamarin.UITest.Queries.QueryPlatform)">
  2398. <summary>
  2399. Initial constructor for queries. Should not be called directly, but used as part of the fluent API in the app classes.
  2400. </summary>
  2401. <param name="queryPlatform">The query target platform.</param>
  2402. </member>
  2403. <member name="M:Xamarin.UITest.Queries.AppQuery.#ctor(Xamarin.UITest.Queries.AppQuery,System.Object[])">
  2404. <summary>
  2405. Constructor for adding more tokens to an existing query in an immutable fashion. Takes the tokens from the old query plus the additional tokens.
  2406. </summary>
  2407. <param name="appQuery">The existing query.</param>
  2408. <param name="tokens">The new query tokens.</param>
  2409. </member>
  2410. <member name="M:Xamarin.UITest.Queries.AppQuery.Button(System.String)">
  2411. <summary>
  2412. Matches a button.
  2413. For Android: An element that has class (or inherits from) <c>android.widget.Button</c>.
  2414. For iOS: An element with class <c>UIButton</c>.
  2415. </summary>
  2416. <param name="marked">Optional argument for matching using marked classification. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more.</param>
  2417. </member>
  2418. <member name="M:Xamarin.UITest.Queries.AppQuery.TextField(System.String)">
  2419. <summary>
  2420. Matches a TextField.
  2421. For Android: An element that has class (or inherits from) <c>android.widget.EditText</c>.
  2422. For iOS: An element with class <c>UITextField</c>.
  2423. </summary>
  2424. <param name="marked">Optional argument for matching using marked classification. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more.</param>
  2425. </member>
  2426. <member name="M:Xamarin.UITest.Queries.AppQuery.Switch(System.String)">
  2427. <summary>
  2428. Matches a Switch.
  2429. For Android: An element that inherits from <c>android.widget.CompoundButton</c>.
  2430. For iOS: An element with class <c>UISwitch</c>.
  2431. </summary>
  2432. <param name="marked">Optional argument for matching using marked classification. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more.</param>
  2433. </member>
  2434. <member name="M:Xamarin.UITest.Queries.AppQuery.Class(System.String)">
  2435. <summary>
  2436. Matches element class.
  2437. For Android (no '.' in className): An element that has a class name of the given value (case insensitive).
  2438. For Android ('.'s in className): An element which has a class (or super class) fully qualified name that matches the value.
  2439. For iOS (first char lowercase): An element that has the class (or super class) name of the given value prepended with "UI". Example: <c>button</c> becomes <c>UIButton</c>.
  2440. For iOS (first char uppercase): An element that has the class (or super class) name of the given value.
  2441. </summary>
  2442. <param name="className">The class name to match.</param>
  2443. </member>
  2444. <member name="M:Xamarin.UITest.Queries.AppQuery.ClassFull(System.String)">
  2445. <summary>
  2446. Matches element class.
  2447. For Android (no '.' in className): An element that has a class name of the given value (case insensitive).
  2448. For Android ('.'s in className): An element which has a class (or super class) fully qualified name that matches the value.
  2449. For iOS: An element that has the class (or super class) name of the given value.
  2450. </summary>
  2451. <param name="className">The class name to match.</param>
  2452. </member>
  2453. <member name="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)">
  2454. <summary>
  2455. Matches common values.
  2456. For Android: An element with the given value as either <c>id</c>, <c>contentDescription</c> or <c>text</c>.
  2457. For iOS: An element with the given value as either <c>accessibilityLabel</c> or <c>accessibilityIdentifier</c>.
  2458. </summary>
  2459. <param name="text">The value to match.</param>
  2460. </member>
  2461. <member name="M:Xamarin.UITest.Queries.AppQuery.Id(System.String)">
  2462. <summary>
  2463. Matches element id.
  2464. For Android: An element with the given value as <c>id</c>.
  2465. For iOS: An element with the given value as <c>accessibilityIdentifier</c>.
  2466. </summary>
  2467. <param name="id">The value to match.</param>
  2468. </member>
  2469. <member name="M:Xamarin.UITest.Queries.AppQuery.Sibling(System.String)">
  2470. <summary>
  2471. Changes the query to return sibling elements of the currently matched ones.
  2472. </summary>
  2473. <param name="className">Optional class name of elements to match.</param>
  2474. </member>
  2475. <member name="M:Xamarin.UITest.Queries.AppQuery.Sibling(System.Int32)">
  2476. <summary>
  2477. Changes the query to return the n'th sibling element of the currently matched ones.
  2478. </summary>
  2479. <param name="index">The zero-based index of the sibling to return.</param>
  2480. <returns>
  2481. </returns>
  2482. </member>
  2483. <member name="M:Xamarin.UITest.Queries.AppQuery.Descendant(System.String)">
  2484. <summary>
  2485. Changes the query to return descendant elements of the currently matched ones.
  2486. </summary>
  2487. <param name="className">Optional class name of elements to match.</param>
  2488. </member>
  2489. <member name="M:Xamarin.UITest.Queries.AppQuery.Descendant(System.Int32)">
  2490. <summary>
  2491. Changes the query to return the n'th descendant element of the currently matched ones.
  2492. </summary>
  2493. <param name="index">The zero-based index of the descendant to return.</param>
  2494. <returns>
  2495. </returns>
  2496. </member>
  2497. <member name="M:Xamarin.UITest.Queries.AppQuery.Parent(System.String)">
  2498. <summary>
  2499. Changes the query to return parent elements of the currently matched ones.
  2500. </summary>
  2501. <param name="className">Optional class name of elements to match.</param>
  2502. </member>
  2503. <member name="M:Xamarin.UITest.Queries.AppQuery.Parent(System.Int32)">
  2504. <summary>
  2505. Changes the query to return the n'th parent element of the currently matched ones.
  2506. </summary>
  2507. <param name="index">The zero-based index of the parent to return.</param>
  2508. <returns>
  2509. </returns>
  2510. </member>
  2511. <member name="M:Xamarin.UITest.Queries.AppQuery.Child(System.String)">
  2512. <summary>
  2513. Changes the query to return child elements of the currently matched ones.
  2514. </summary>
  2515. <param name="className">Optional class name of elements to match.</param>
  2516. </member>
  2517. <member name="M:Xamarin.UITest.Queries.AppQuery.Child(System.Int32)">
  2518. <summary>
  2519. Changes the query to return the n'th child element of the currently matched ones.
  2520. </summary>
  2521. <param name="index">The zero-based index of the child to return.</param>
  2522. <returns>
  2523. </returns>
  2524. </member>
  2525. <member name="M:Xamarin.UITest.Queries.AppQuery.All(System.String)">
  2526. <summary>
  2527. Changes the query to return all elements instead of just the visible ones.
  2528. </summary>
  2529. <param name="className">Optional class name of elements to match.</param>
  2530. </member>
  2531. <member name="M:Xamarin.UITest.Queries.AppQuery.Text(System.String)">
  2532. <summary>
  2533. Matches element text.
  2534. </summary>
  2535. <param name="text">The value to match.</param>
  2536. </member>
  2537. <member name="M:Xamarin.UITest.Queries.AppQuery.Index(System.Int32)">
  2538. <summary>
  2539. Matches the nth element of the currently matched elements.
  2540. </summary>
  2541. <param name="index">The zero-based index of the element to match.</param>
  2542. </member>
  2543. <member name="M:Xamarin.UITest.Queries.AppQuery.WebView">
  2544. <summary>
  2545. Matches WebViews
  2546. </summary>
  2547. </member>
  2548. <member name="M:Xamarin.UITest.Queries.AppQuery.WebView(System.Int32)">
  2549. <summary>
  2550. Matches the nth WebView
  2551. </summary>
  2552. <param name="index">The zero-based index of the webview to return.</param>
  2553. </member>
  2554. <member name="M:Xamarin.UITest.Queries.AppQuery.Raw(System.String)">
  2555. <summary>
  2556. A raw Calabash selector. Allows for string based Calabash queries.
  2557. </summary>
  2558. <param name="calabashQuery">The Calabash query to match.</param>
  2559. </member>
  2560. <member name="M:Xamarin.UITest.Queries.AppQuery.Raw(System.String,System.Object)">
  2561. <summary>
  2562. A raw Calabash selector. Allows for string based Calabash queries.
  2563. </summary>
  2564. <param name="calabashQuery">The Calabash query to match.</param>
  2565. <param name="arg1">A raw argument to pass to the Calabash query.</param>
  2566. </member>
  2567. <member name="M:Xamarin.UITest.Queries.AppQuery.Raw(System.String,System.Object,System.Object)">
  2568. <summary>
  2569. A raw Calabash selector. Allows for string based Calabash queries.
  2570. </summary>
  2571. <param name="calabashQuery">The Calabash query to match.</param>
  2572. <param name="arg1">A raw argument to pass to the Calabash query.</param>
  2573. <param name="arg2">A raw argument to pass to the Calabash query.</param>
  2574. </member>
  2575. <member name="M:Xamarin.UITest.Queries.AppQuery.Raw(System.String,System.Object,System.Object,System.Object)">
  2576. <summary>
  2577. A raw Calabash selector. Allows for string based Calabash queries.
  2578. </summary>
  2579. <param name="calabashQuery">The Calabash query to match.</param>
  2580. <param name="arg1">A raw argument to pass to the Calabash query.</param>
  2581. <param name="arg2">A raw argument to pass to the Calabash query.</param>
  2582. <param name="arg3">A raw argument to pass to the Calabash query.</param>
  2583. </member>
  2584. <member name="M:Xamarin.UITest.Queries.AppQuery.Raw(System.String,System.Object,System.Object,System.Object,System.Object)">
  2585. <summary>
  2586. A raw Calabash selector. Allows for string based Calabash queries.
  2587. </summary>
  2588. <param name="calabashQuery">The Calabash query to match.</param>
  2589. <param name="arg1">A raw argument to pass to the Calabash query.</param>
  2590. <param name="arg2">A raw argument to pass to the Calabash query.</param>
  2591. <param name="arg3">A raw argument to pass to the Calabash query.</param>
  2592. <param name="arg4">A raw argument to pass to the Calabash query.</param>
  2593. </member>
  2594. <member name="M:Xamarin.UITest.Queries.AppQuery.Raw(System.String,System.Object,System.Object,System.Object,System.Object,System.Object)">
  2595. <summary>
  2596. A raw Calabash selector. Allows for string based Calabash queries.
  2597. </summary>
  2598. <param name="calabashQuery">The Calabash query to match.</param>
  2599. <param name="arg1">A raw argument to pass to the Calabash query.</param>
  2600. <param name="arg2">A raw argument to pass to the Calabash query.</param>
  2601. <param name="arg3">A raw argument to pass to the Calabash query.</param>
  2602. <param name="arg4">A raw argument to pass to the Calabash query.</param>
  2603. <param name="arg5">A raw argument to pass to the Calabash query.</param>
  2604. </member>
  2605. <member name="M:Xamarin.UITest.Queries.AppQuery.Raw(System.String,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  2606. <summary>
  2607. A raw Calabash selector. Allows for string based Calabash queries.
  2608. </summary>
  2609. <param name="calabashQuery">The Calabash query to match.</param>
  2610. <param name="arg1">A raw argument to pass to the Calabash query.</param>
  2611. <param name="arg2">A raw argument to pass to the Calabash query.</param>
  2612. <param name="arg3">A raw argument to pass to the Calabash query.</param>
  2613. <param name="arg4">A raw argument to pass to the Calabash query.</param>
  2614. <param name="arg5">A raw argument to pass to the Calabash query.</param>
  2615. <param name="arg6">A raw argument to pass to the Calabash query.</param>
  2616. </member>
  2617. <member name="M:Xamarin.UITest.Queries.AppQuery.Invoke(System.String)">
  2618. <summary>
  2619. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  2620. </summary>
  2621. <param name="methodName">The name of the method.</param>
  2622. </member>
  2623. <member name="M:Xamarin.UITest.Queries.AppQuery.Invoke(System.String,System.Object)">
  2624. <summary>
  2625. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  2626. </summary>
  2627. <param name="methodName">The name of the method.</param>
  2628. <param name="arg1">The 1st parameter.</param>
  2629. </member>
  2630. <member name="M:Xamarin.UITest.Queries.AppQuery.Invoke(System.String,System.Object,System.Object)">
  2631. <summary>
  2632. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  2633. </summary>
  2634. <param name="methodName">The name of the method.</param>
  2635. <param name="arg1">The 1st parameter.</param>
  2636. <param name="arg2">The 2nd parameter.</param>
  2637. </member>
  2638. <member name="M:Xamarin.UITest.Queries.AppQuery.Invoke(System.String,System.Object,System.Object,System.Object)">
  2639. <summary>
  2640. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  2641. </summary>
  2642. <param name="methodName">The name of the method.</param>
  2643. <param name="arg1">The 1st parameter.</param>
  2644. <param name="arg2">The 2nd parameter.</param>
  2645. <param name="arg3">The 3rd parameter.</param>
  2646. </member>
  2647. <member name="M:Xamarin.UITest.Queries.AppQuery.Invoke(System.String,System.Object,System.Object,System.Object,System.Object)">
  2648. <summary>
  2649. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  2650. </summary>
  2651. <param name="methodName">The name of the method.</param>
  2652. <param name="arg1">The 1st parameter.</param>
  2653. <param name="arg2">The 2nd parameter.</param>
  2654. <param name="arg3">The 3rd parameter.</param>
  2655. <param name="arg4">The 4th parameter.</param>
  2656. </member>
  2657. <member name="M:Xamarin.UITest.Queries.AppQuery.Invoke(System.String,System.Object,System.Object,System.Object,System.Object,System.Object)">
  2658. <summary>
  2659. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  2660. </summary>
  2661. <param name="methodName">The name of the method.</param>
  2662. <param name="arg1">The 1st parameter.</param>
  2663. <param name="arg2">The 2nd parameter.</param>
  2664. <param name="arg3">The 3rd parameter.</param>
  2665. <param name="arg4">The 4th parameter.</param>
  2666. <param name="arg5">The 5th parameter.</param>
  2667. </member>
  2668. <member name="M:Xamarin.UITest.Queries.AppQuery.InvokeJS(System.String)">
  2669. <summary>
  2670. Invokes javascript on the view elements matched by the query. If view elements other than WebViews are encountered, the execution will halt and an Exception will be thrown.
  2671. </summary>
  2672. <param name="javascript">The javascript to invoke on the views</param>
  2673. <returns>
  2674. </returns>
  2675. </member>
  2676. <member name="M:Xamarin.UITest.Queries.AppQuery.Css(System.String)">
  2677. <summary>
  2678. Matches elements in web views matching the given css selector. Must be used on web view elements. If used alone, will default to <c>android.webkit.WebView</c> for Android and <c>UIWebView</c> for iOS.
  2679. </summary>
  2680. <param name="cssSelector">The css selector to match.</param>
  2681. </member>
  2682. <member name="M:Xamarin.UITest.Queries.AppQuery.XPath(System.String)">
  2683. <summary>
  2684. Matches elements in web views matching the given XPath selector. Must be used on web view elements. If used alone, will default to <c>android.webkit.WebView</c> for Android and <c>UIWebView</c> for iOS.
  2685. </summary>
  2686. <param name="xPathSelector">The css selector to match.</param>
  2687. </member>
  2688. <member name="M:Xamarin.UITest.Queries.AppQuery.Property(System.String,System.String)">
  2689. <summary>
  2690. Matches a property or getter method value on the element.
  2691. </summary>
  2692. <param name="propertyName">The name of the property.</param>
  2693. <param name="value">The value to match.</param>
  2694. </member>
  2695. <member name="M:Xamarin.UITest.Queries.AppQuery.Property(System.String,System.Int32)">
  2696. <summary>
  2697. Matches a property or getter method value on the element.
  2698. </summary>
  2699. <param name="propertyName">The name of the property.</param>
  2700. <param name="value">The value to match.</param>
  2701. </member>
  2702. <member name="M:Xamarin.UITest.Queries.AppQuery.Property(System.String,System.Boolean)">
  2703. <summary>
  2704. Matches a property or getter method value on the element.
  2705. </summary>
  2706. <param name="propertyName">The name of the property.</param>
  2707. <param name="value">The value to match.</param>
  2708. </member>
  2709. <member name="M:Xamarin.UITest.Queries.AppQuery.Property(System.String)">
  2710. <summary>
  2711. Allows for further filtering on a given property value.
  2712. </summary>
  2713. <param name="propertyName">The name of the property.</param>
  2714. </member>
  2715. <member name="P:Xamarin.UITest.Queries.AppQuery.QueryPlatform">
  2716. <summary>
  2717. The target platform of the query. Useful when writing extensions methods for queries for platform differences.
  2718. </summary>
  2719. </member>
  2720. <member name="M:Xamarin.UITest.Queries.AppQuery.ToString">
  2721. <summary>
  2722. Converts the string into it's Calabash query equivalent.
  2723. </summary>
  2724. </member>
  2725. <member name="T:Xamarin.UITest.Queries.QueryPlatform">
  2726. <summary>
  2727. Representation of the different platforms a query can be targettet at.
  2728. </summary>
  2729. </member>
  2730. <member name="F:Xamarin.UITest.Queries.QueryPlatform.Android">
  2731. <summary>
  2732. The Android platform.
  2733. </summary>
  2734. </member>
  2735. <member name="F:Xamarin.UITest.Queries.QueryPlatform.iOS">
  2736. <summary>
  2737. The iOS platform.
  2738. </summary>
  2739. </member>
  2740. <member name="T:Xamarin.UITest.IApp">
  2741. <summary>
  2742. Represents the main gateway to interact with an app. This interface contains shared
  2743. functionality between <see cref="T:Xamarin.UITest.Android.AndroidApp" /> and <see cref="T:Xamarin.UITest.iOS.iOSApp" />.
  2744. </summary>
  2745. </member>
  2746. <member name="M:Xamarin.UITest.IApp.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  2747. <summary>
  2748. Queries view objects using the fluent API. Defaults to only return view objects that are visible.
  2749. </summary>
  2750. <param name="query">Entry point for the fluent API to specify the element. If left as <c>null</c> returns all visible view objects.</param>
  2751. <returns>An array representing the matched view objects.</returns>
  2752. </member>
  2753. <member name="M:Xamarin.UITest.IApp.Query(System.String)">
  2754. <summary>
  2755. Queries view objects using the fluent API. Defaults to only return view objects that are visible.
  2756. </summary>
  2757. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  2758. <returns>An array representing the matched view objects.</returns>
  2759. </member>
  2760. <member name="M:Xamarin.UITest.IApp.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery})">
  2761. <summary>
  2762. Queries web view objects using the fluent API. Defaults to only return view objects that are visible.
  2763. </summary>
  2764. <param name="query">Entry point for the fluent API to specify the element. If left as <c>null</c> returns all visible view objects.</param>
  2765. <returns>An array representing the matched view objects.</returns>
  2766. </member>
  2767. <member name="M:Xamarin.UITest.IApp.Query``1(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppTypedSelector{``0}})">
  2768. <summary>
  2769. Queries properties on view objects using the fluent API.
  2770. </summary>
  2771. <param name="query">Entry point for the fluent API to specify the type of the property.</param>
  2772. <typeparam name="T">The type of the property.</typeparam>
  2773. </member>
  2774. <member name="M:Xamarin.UITest.IApp.Query(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.InvokeJSAppQuery})">
  2775. <summary>
  2776. Invokes Javascript on view objects using the fluent API.
  2777. </summary>
  2778. <param name="query">Entry point for the fluent API to specify the elements.</param>
  2779. <returns>An array of strings representing the results.</returns>
  2780. </member>
  2781. <member name="M:Xamarin.UITest.IApp.Flash(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  2782. <summary>
  2783. Highlights the results of the query by making them flash. Specify view elements using the fluent API. Defaults to all view objects that are visible.
  2784. </summary>
  2785. <param name="query">Entry point for the fluent API to specify the elements. If left as <c>null</c> flashes all visible view objects.</param>
  2786. <returns>An array representing the matched view objects.</returns>
  2787. </member>
  2788. <member name="M:Xamarin.UITest.IApp.Flash(System.String)">
  2789. <summary>
  2790. Highlights the results of the query by making them flash. Specify view elements using marked string.
  2791. </summary>
  2792. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  2793. <returns>An array representing the matched view objects.</returns>
  2794. </member>
  2795. <member name="M:Xamarin.UITest.IApp.EnterText(System.String)">
  2796. <summary>
  2797. Enters text into the currently focused element.
  2798. </summary>
  2799. <param name="text">The text to enter.</param>
  2800. </member>
  2801. <member name="M:Xamarin.UITest.IApp.EnterText(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.String)">
  2802. <summary>
  2803. Enters text into a matching element that supports it.
  2804. </summary>
  2805. <param name="query">Entry point for the fluent API to specify the element.</param>
  2806. <param name="text">The text to enter.</param>
  2807. </member>
  2808. <member name="M:Xamarin.UITest.IApp.EnterText(System.String,System.String)">
  2809. <summary>
  2810. Enters text into a matching element that supports it.
  2811. </summary>
  2812. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  2813. <param name="text">The text to enter.</param>
  2814. </member>
  2815. <member name="M:Xamarin.UITest.IApp.EnterText(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String)">
  2816. <summary>
  2817. Enters text into a matching element that supports it.
  2818. </summary>
  2819. <param name="query">Entry point for the fluent API to specify the element.</param>
  2820. <param name="text">The text to enter.</param>
  2821. </member>
  2822. <member name="M:Xamarin.UITest.IApp.ClearText(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  2823. <summary>
  2824. Clears text from a matching element that supports it.
  2825. </summary>
  2826. <param name="query">Entry point for the fluent API to specify the element.</param>
  2827. </member>
  2828. <member name="M:Xamarin.UITest.IApp.ClearText(System.String)">
  2829. <summary>
  2830. Clears text from a matching element that supports it.
  2831. </summary>
  2832. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  2833. </member>
  2834. <member name="M:Xamarin.UITest.IApp.ClearText">
  2835. <summary>
  2836. Clears text from the currently focused element.
  2837. </summary>
  2838. </member>
  2839. <member name="M:Xamarin.UITest.IApp.PressEnter">
  2840. <summary>
  2841. Presses the enter key in the app.
  2842. </summary>
  2843. </member>
  2844. <member name="M:Xamarin.UITest.IApp.DismissKeyboard">
  2845. <summary>
  2846. Hides keyboard if present
  2847. </summary>
  2848. </member>
  2849. <member name="M:Xamarin.UITest.IApp.Tap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  2850. <summary>
  2851. Performs a tap / touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  2852. </summary>
  2853. <param name="query">Entry point for the fluent API to specify the element.</param>
  2854. </member>
  2855. <member name="M:Xamarin.UITest.IApp.Tap(System.String)">
  2856. <summary>
  2857. Performs a tap / touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  2858. </summary>
  2859. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  2860. </member>
  2861. <member name="M:Xamarin.UITest.IApp.Tap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery})">
  2862. <summary>
  2863. Performs a tap / touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  2864. </summary>
  2865. <param name="query">Entry point for the fluent API to specify the element.</param>
  2866. </member>
  2867. <member name="M:Xamarin.UITest.IApp.TapCoordinates(System.Single,System.Single)">
  2868. <summary>
  2869. Performs a tap / touch gesture on the given coordinates.
  2870. </summary>
  2871. <param name="x">The x coordinate to tap.</param>
  2872. <param name="y">The y coordinate to tap.</param>
  2873. </member>
  2874. <member name="M:Xamarin.UITest.IApp.TouchAndHold(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  2875. <summary>
  2876. Performs a continuous touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  2877. </summary>
  2878. <param name="query">Entry point for the fluent API to specify the element.</param>
  2879. </member>
  2880. <member name="M:Xamarin.UITest.IApp.TouchAndHold(System.String)">
  2881. <summary>
  2882. Performs a continuous touch gesture on the matched element. If multiple elements are matched, the first one will be used.
  2883. </summary>
  2884. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  2885. </member>
  2886. <member name="M:Xamarin.UITest.IApp.TouchAndHoldCoordinates(System.Single,System.Single)">
  2887. <summary>
  2888. Performs a continuous touch gesture on the given coordinates.
  2889. </summary>
  2890. <param name="x">The x coordinate to touch.</param>
  2891. <param name="y">The y coordinate to touch.</param>
  2892. </member>
  2893. <member name="M:Xamarin.UITest.IApp.DoubleTap(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery})">
  2894. <summary>
  2895. Performs two quick tap / touch gestures on the matched element. If multiple elements are matched, the first one will be used.
  2896. </summary>
  2897. <param name="query">Entry point for the fluent API to specify the element.</param>
  2898. </member>
  2899. <member name="M:Xamarin.UITest.IApp.DoubleTap(System.String)">
  2900. <summary>
  2901. Performs two quick tap / touch gestures on the matched element. If multiple elements are matched, the first one will be used.
  2902. </summary>
  2903. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  2904. </member>
  2905. <member name="M:Xamarin.UITest.IApp.DoubleTapCoordinates(System.Single,System.Single)">
  2906. <summary>
  2907. Performs a quick double tap / touch gesture on the given coordinates.
  2908. </summary>
  2909. <param name="x">The x coordinate to touch.</param>
  2910. <param name="y">The y coordinate to touch.</param>
  2911. </member>
  2912. <member name="M:Xamarin.UITest.IApp.PinchToZoomIn(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Nullable{System.TimeSpan})">
  2913. <summary>
  2914. Performs a pinch gestures on the matched element to zoom the view in. If multiple elements are matched, the first one will be used.
  2915. </summary>
  2916. <param name="query">Entry point for the fluent API to specify the element.</param>
  2917. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  2918. </member>
  2919. <member name="M:Xamarin.UITest.IApp.PinchToZoomIn(System.String,System.Nullable{System.TimeSpan})">
  2920. <summary>
  2921. Performs a pinch gestures on the matched element to zoom the view in. If multiple elements are matched, the first one will be used.
  2922. </summary>
  2923. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  2924. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  2925. </member>
  2926. <member name="M:Xamarin.UITest.IApp.PinchToZoomInCoordinates(System.Single,System.Single,System.Nullable{System.TimeSpan})">
  2927. <summary>
  2928. Performs a pinch gestures to zoom the view in on the given coordinates.
  2929. </summary>
  2930. <param name="x">The x coordinate of the center of the pinch.</param>
  2931. <param name="y">The y coordinate of the center of the pinch.</param>
  2932. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  2933. </member>
  2934. <member name="M:Xamarin.UITest.IApp.PinchToZoomOut(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Nullable{System.TimeSpan})">
  2935. <summary>
  2936. Performs a pinch gestures on the matched element to zoom the view out. If multiple elements are matched, the first one will be used.
  2937. </summary>
  2938. <param name="query">Entry point for the fluent API to specify the element.</param>
  2939. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  2940. </member>
  2941. <member name="M:Xamarin.UITest.IApp.PinchToZoomOut(System.String,System.Nullable{System.TimeSpan})">
  2942. <summary>
  2943. Performs a pinch gestures on the matched element to zoom the view out. If multiple elements are matched, the first one will be used.
  2944. </summary>
  2945. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  2946. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  2947. </member>
  2948. <member name="M:Xamarin.UITest.IApp.PinchToZoomOutCoordinates(System.Single,System.Single,System.Nullable{System.TimeSpan})">
  2949. <summary>
  2950. Performs a pinch gestures to zoom the view in on the given coordinates.
  2951. </summary>
  2952. <param name="x">The x coordinate of the center of the pinch.</param>
  2953. <param name="y">The y coordinate of the center of the pinch.</param>
  2954. <param name="duration">The <see cref="T:System.TimeSpan" /> duration of the pinch gesture.</param>
  2955. </member>
  2956. <member name="M:Xamarin.UITest.IApp.WaitFor(System.Func{System.Boolean},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  2957. <summary>
  2958. Generic wait function that will repeatly call the <c>predicate</c> function until it returns <c>true</c>. Throws a <see cref="T:System.TimeoutException" /> if the predicate is not fullfilled within the time limit.
  2959. </summary>
  2960. <param name="predicate">Predicate function that should return <c>true</c> when waiting is complete.</param>
  2961. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  2962. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  2963. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each call to the predicate.</param>
  2964. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the predicate returns <c>true</c>.</param>
  2965. </member>
  2966. <member name="M:Xamarin.UITest.IApp.WaitForElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  2967. <summary>
  2968. Wait function that will repeatly query the app until a matching element is found. Throws a <see cref="T:System.TimeoutException" /> if no element is found within the time limit.
  2969. </summary>
  2970. <param name="query">Entry point for the fluent API to specify the element.</param>
  2971. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  2972. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  2973. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  2974. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element has been found.</param>
  2975. <returns>An array representing the matched view objects.</returns>
  2976. </member>
  2977. <member name="M:Xamarin.UITest.IApp.WaitForElement(System.String,System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  2978. <summary>
  2979. Wait function that will repeatly query the app until a matching element is found. Throws a <see cref="T:System.TimeoutException" /> if no element is found within the time limit.
  2980. </summary>
  2981. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  2982. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  2983. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  2984. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  2985. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element has been found.</param>
  2986. <returns>An array representing the matched view objects.</returns>
  2987. </member>
  2988. <member name="M:Xamarin.UITest.IApp.WaitForElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  2989. <summary>
  2990. Wait function that will repeatly query the app until a matching element is found. Throws a <see cref="T:System.TimeoutException" /> if no element is found within the time limit.
  2991. </summary>
  2992. <param name="query">Entry point for the fluent API to specify the element.</param>
  2993. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  2994. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  2995. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  2996. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element has been found.</param>
  2997. <returns>An array representing the matched view objects.</returns>
  2998. </member>
  2999. <member name="M:Xamarin.UITest.IApp.WaitForNoElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  3000. <summary>
  3001. Wait function that will repeatly query the app until a matching element is no longer found. Throws a <see cref="T:System.TimeoutException" /> if the element is visible at the end of the time limit.
  3002. </summary>
  3003. <param name="query">Entry point for the fluent API to specify the element.</param>
  3004. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  3005. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  3006. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  3007. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element is no longer visible.</param>
  3008. </member>
  3009. <member name="M:Xamarin.UITest.IApp.WaitForNoElement(System.String,System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  3010. <summary>
  3011. Wait function that will repeatly query the app until a matching element is no longer found. Throws a <see cref="T:System.TimeoutException" /> if the element is visible at the end of the time limit.
  3012. </summary>
  3013. <param name="marked">Marked selector to match. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3014. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  3015. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  3016. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  3017. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element is no longer visible.</param>
  3018. </member>
  3019. <member name="M:Xamarin.UITest.IApp.WaitForNoElement(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})">
  3020. <summary>
  3021. Wait function that will repeatly query the app until a matching element is no longer found. Throws a <see cref="T:System.TimeoutException" /> if the element is visible at the end of the time limit.
  3022. </summary>
  3023. <param name="query">Entry point for the fluent API to specify the element.</param>
  3024. <param name="timeoutMessage">The message used in the <see cref="T:System.TimeoutException" />.</param>
  3025. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  3026. <param name="retryFrequency">The <see cref="T:System.TimeSpan" /> to wait between each query call to the app.</param>
  3027. <param name="postTimeout">The final <see cref="T:System.TimeSpan" /> to wait after the element is no longer visible.</param>
  3028. </member>
  3029. <member name="M:Xamarin.UITest.IApp.Screenshot(System.String)">
  3030. <summary>
  3031. Takes a screenshot of the app in it's current state. This is used to denote test steps in the Xamarin Test Cloud.
  3032. </summary>
  3033. <param name="title">The title of screenshot, used as step name.</param>
  3034. <returns>The screenshot file.</returns>
  3035. </member>
  3036. <member name="M:Xamarin.UITest.IApp.SwipeRight">
  3037. <summary>
  3038. Performs a left to right swipe gesture.
  3039. </summary>
  3040. </member>
  3041. <member name="M:Xamarin.UITest.IApp.SwipeLeft">
  3042. <summary>
  3043. Performs a right to left swipe gesture.
  3044. </summary>
  3045. </member>
  3046. <member name="M:Xamarin.UITest.IApp.ScrollUp(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy)">
  3047. <summary>
  3048. Scrolls up on the first element matching query.
  3049. </summary>
  3050. <param name="query">Entry point for the fluent API to specify the elements.</param>
  3051. <param name="strategy">Strategy for scrolling element</param>
  3052. </member>
  3053. <member name="M:Xamarin.UITest.IApp.ScrollUp(System.String,Xamarin.UITest.ScrollStrategy)">
  3054. <summary>
  3055. Scrolls up on the first element matching query.
  3056. </summary>
  3057. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3058. <param name="strategy">Strategy for scrolling element.</param>
  3059. </member>
  3060. <member name="M:Xamarin.UITest.IApp.ScrollDown(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy)">
  3061. <summary>
  3062. Scrolls down on the first element matching query.
  3063. </summary>
  3064. <param name="withinQuery">Entry point for the fluent API to specify the what element to scroll within.</param>
  3065. <param name="strategy">Strategy for scrolling element.</param>
  3066. </member>
  3067. <member name="M:Xamarin.UITest.IApp.ScrollDown(System.String,Xamarin.UITest.ScrollStrategy)">
  3068. <summary>
  3069. Scrolls down on the first element matching query.
  3070. </summary>
  3071. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3072. <param name="strategy">Strategy for scrolling element.</param>
  3073. </member>
  3074. <member name="M:Xamarin.UITest.IApp.ScrollTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  3075. <summary>
  3076. Scroll until an element that mactches the <c>toMarked</c> is shown on the screen.
  3077. </summary>
  3078. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3079. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3080. <param name="strategy">Strategy for scrolling element.</param>
  3081. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  3082. </member>
  3083. <member name="M:Xamarin.UITest.IApp.ScrollUpTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  3084. <summary>
  3085. Scroll up until an element that mactches the <c>toMarked</c> is shown on the screen.
  3086. </summary>
  3087. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3088. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3089. <param name="strategy">Strategy for scrolling element.</param>
  3090. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  3091. </member>
  3092. <member name="M:Xamarin.UITest.IApp.ScrollUpTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  3093. <summary>
  3094. Scroll up until an element that mactches the <c>toMarked</c> is shown on the screen.
  3095. </summary>
  3096. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  3097. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3098. <param name="strategy">Strategy for scrolling element.</param>
  3099. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  3100. </member>
  3101. <member name="M:Xamarin.UITest.IApp.ScrollDownTo(System.String,System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  3102. <summary>
  3103. Scroll down until an element that mactches the <c>toMarked</c> is shown on the screen.
  3104. </summary>
  3105. <param name="toMarked">Marked selector to select what element to bring on screen. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3106. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3107. <param name="strategy">Strategy for scrolling element.</param>
  3108. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  3109. </member>
  3110. <member name="M:Xamarin.UITest.IApp.ScrollDownTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.String,Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  3111. <summary>
  3112. Scroll down until an element that mactches the <c>toMarked</c> is shown on the screen.
  3113. </summary>
  3114. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  3115. <param name="withinMarked">Marked selector to select what element to scroll within. See <see cref="M:Xamarin.UITest.Queries.AppQuery.Marked(System.String)" /> for more information.</param>
  3116. <param name="strategy">Strategy for scrolling element.</param>
  3117. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  3118. </member>
  3119. <member name="M:Xamarin.UITest.IApp.ScrollUpTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  3120. <summary>
  3121. Scroll up until an element that mactches the <c>toQuery</c> is shown on the screen.
  3122. </summary>
  3123. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  3124. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  3125. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  3126. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  3127. </member>
  3128. <member name="M:Xamarin.UITest.IApp.ScrollUpTo(System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppWebQuery},System.Func{Xamarin.UITest.Queries.AppQuery,Xamarin.UITest.Queries.AppQuery},Xamarin.UITest.ScrollStrategy,System.Nullable{System.TimeSpan})">
  3129. <summary>
  3130. Scroll up until an element that mactches the <c>toQuery</c> is shown on the screen.
  3131. </summary>
  3132. <param name="toQuery">Entry point for the fluent API to specify the element to bring on screen.</param>
  3133. <param name="withinQuery">Entry point for the fluent API to specify what element to scroll within.</param>
  3134. <param name="strategy">Strategy for scrolling element, Ignored for IOS, will always use <c>ScrollStrategy.Programmatically</c></param>
  3135. <param name="timeout">The <see cref="T:System.TimeSpan" /> to wait before failing.</param>
  3136. </member>
  3137. <member name="M:Xamarin.UITest.IApp.SetOrientationPortrait">
  3138. <summary>
  3139. Changes the device orientation to portrait mode.
  3140. </summary>
  3141. </member>
  3142. <member name="M:Xamarin.UITest.IApp.SetOrientationLandscape">
  3143. <summary>
  3144. Changes the device orientation to landscape mode.
  3145. </summary>
  3146. </member>
  3147. <member name="P:Xamarin.UITest.IApp.Print">
  3148. <summary>
  3149. Contains helper methods for outputting the result of queries instead of resorting to <see cref="T:System.Console" />.
  3150. </summary>
  3151. </member>
  3152. <member name="M:Xamarin.UITest.IApp.Repl">
  3153. <summary>
  3154. Starts an interactive REPL (Read-Eval-Print-Loop) for app exploration and pauses test execution until it is closed.
  3155. </summary>
  3156. </member>
  3157. <member name="P:Xamarin.UITest.IApp.Device">
  3158. <summary>
  3159. Device information and Control
  3160. </summary>
  3161. </member>
  3162. <member name="M:Xamarin.UITest.IApp.Back">
  3163. <summary>
  3164. Navigate back on the device.
  3165. </summary>
  3166. </member>
  3167. <member name="M:Xamarin.UITest.IApp.PressVolumeUp">
  3168. <summary>
  3169. Presses the volume up button on the device.
  3170. </summary>
  3171. </member>
  3172. <member name="M:Xamarin.UITest.IApp.PressVolumeDown">
  3173. <summary>
  3174. Presses the volume down button on the device.
  3175. </summary>
  3176. </member>
  3177. <member name="P:Xamarin.UITest.IApp.TestServer">
  3178. <summary>
  3179. Allows HTTP access to the test server running on the device.
  3180. </summary>
  3181. </member>
  3182. <member name="M:Xamarin.UITest.IApp.Invoke(System.String,System.Object)">
  3183. <summary>
  3184. Invokes a method on the app's main activity for Android and app delegate for iOS. For Xamarin apps, methods must be exposed using attributes as shown below.
  3185. Android example in activity:
  3186. <code>
  3187. [Export]
  3188. public string MyInvokeMethod(string arg)
  3189. {
  3190. return "uitest";
  3191. }
  3192. </code>
  3193. iOS example in app delegate:
  3194. <code>
  3195. [Export("myInvokeMethod:")]
  3196. public NSString MyInvokeMethod(NSString arg)
  3197. {
  3198. return new NSString("uitest");
  3199. }
  3200. </code></summary>
  3201. <param name="methodName">The name of the method to invoke.</param>
  3202. <param name="argument">The argument to pass to the method.</param>
  3203. <returns>The result of the invocation.</returns>
  3204. </member>
  3205. <member name="M:Xamarin.UITest.IApp.DragCoordinates(System.Single,System.Single,System.Single,System.Single)">
  3206. <summary>
  3207. Performs a continuous drag gesture between 2 points.
  3208. </summary>
  3209. <param name="fromX">The x coordinate to start dragging from.</param>
  3210. <param name="fromY">The y coordinate to start dragging from.</param>
  3211. <param name="toX">The x coordinate to drag to.</param>
  3212. <param name="toY">The y coordinate to drag to.</param>
  3213. </member>
  3214. <member name="T:Xamarin.UITest.Queries.Tokens.IQueryToken">
  3215. <summary>
  3216. A query token. Part of a query for matching view elements for queries and gestures.
  3217. </summary>
  3218. </member>
  3219. <member name="M:Xamarin.UITest.Queries.Tokens.IQueryToken.ToQueryString(Xamarin.UITest.Queries.QueryPlatform)">
  3220. <summary>
  3221. Converts the query token to a Calabash query string.
  3222. </summary>
  3223. <param name="queryPlatform">The target query platform.</param>
  3224. <returns>A valid Calabash query string.</returns>
  3225. </member>
  3226. <member name="M:Xamarin.UITest.Queries.Tokens.IQueryToken.ToCodeString">
  3227. <summary>
  3228. Returns a string representation of the code representing the query. Used for output.
  3229. </summary>
  3230. <returns>A string representation of the query code.</returns>
  3231. </member>
  3232. <member name="T:Xamarin.UITest.Queries.ITokenContainer">
  3233. <summary>
  3234. Helper interface for exposing tokens from the fluent query API without cluttering the fluent API itself (when using explicit interface implementation).
  3235. </summary>
  3236. </member>
  3237. <member name="P:Xamarin.UITest.Queries.ITokenContainer.Tokens">
  3238. <summary>
  3239. The tokens of the current query.
  3240. </summary>
  3241. </member>
  3242. <member name="T:Xamarin.UITest.Configuration.IiOSAppConfiguration">
  3243. <summary>
  3244. Configuration for iOS apps. Not to be used directly, should be created by using the fluent <see cref="T:Xamarin.UITest.ConfigureApp" /> API.
  3245. </summary>
  3246. </member>
  3247. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.Debug">
  3248. <summary>
  3249. Enable debug logging.
  3250. </summary>
  3251. </member>
  3252. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.EnableScreenshots">
  3253. <summary>
  3254. Enable screenshots. Local screenshots are disabled by default to speed up tests.
  3255. </summary>
  3256. </member>
  3257. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.LogDirectory">
  3258. <summary>
  3259. Specify the location of the log directory for local test runs.
  3260. </summary>
  3261. </member>
  3262. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.DeviceUri">
  3263. <summary>
  3264. The uri of the device test server.
  3265. </summary>
  3266. </member>
  3267. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.ConfiguredDeviceIp">
  3268. <summary>
  3269. The configured ip address. Use <c>DeviceUri</c> for the active configuration.
  3270. </summary>
  3271. <value>The configured ip address.</value>
  3272. </member>
  3273. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.ConfiguredDevicePort">
  3274. <summary>
  3275. The configured port. Use <c>DeviceUri</c> for the active configuration.
  3276. </summary>
  3277. <value>The configured ip address.</value>
  3278. </member>
  3279. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.DeviceIdentifier">
  3280. <summary>
  3281. The device identifier. List of know devices can be found by running "instruments -s devices"
  3282. </summary>
  3283. </member>
  3284. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.InstalledAppBundleId">
  3285. <summary>
  3286. The bundle id of an already installed to test.
  3287. </summary>
  3288. </member>
  3289. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.AppBundleDirectory">
  3290. <summary>
  3291. The location of an app bundle for a simulator test.
  3292. </summary>
  3293. </member>
  3294. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.AppBundleZip">
  3295. <summary>
  3296. The location of a zip archive for a simulator test.
  3297. </summary>
  3298. </member>
  3299. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.StartAction">
  3300. <summary>
  3301. The desired state of the app after test initialization. Either the test framework can start the app or connect to an already running app in more advanced scenarios.
  3302. </summary>
  3303. </member>
  3304. <member name="M:Xamarin.UITest.Configuration.IiOSAppConfiguration.Verify">
  3305. <summary>
  3306. Verify the state of a configuration. Throw exception if invalid.
  3307. </summary>
  3308. </member>
  3309. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.WaitTimes">
  3310. <summary>
  3311. Default wait times.
  3312. </summary>
  3313. </member>
  3314. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.ApiKey">
  3315. <summary>
  3316. The Xamarin Test Cloud api key to use for activation.
  3317. </summary>
  3318. </member>
  3319. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.IdeIntegrationMode">
  3320. <summary>
  3321. The IDE integration mode. Decides what settings to use in case of both explicit configuration and active IDE integration.
  3322. </summary>
  3323. </member>
  3324. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.AppDataMode">
  3325. <summary>
  3326. Whether to clear app data or not.
  3327. </summary>
  3328. </member>
  3329. <member name="P:Xamarin.UITest.Configuration.IiOSAppConfiguration.DisableSpecFlowIntegration">
  3330. <summary>
  3331. Whether to disables automatic screenshot generation after each SpecFlow step.
  3332. </summary>
  3333. </member>
  3334. <member name="M:Xamarin.UITest.Utils.Integration.IdeConnection.Connect(System.String,Xamarin.UITest.Platform)">
  3335. <summary>
  3336. Starts a connection with an IDE that may be ready to provide additional services for running a UITest session.
  3337. </summary>
  3338. <param name="testAssemblyPath">Full path to the test assembly</param>
  3339. <param name="platform">Target test platform: iOS, Android</param>
  3340. <returns>
  3341. <c>true</c>, if there is an IDE listening that can handle this test run session, <c>false</c> otherwise.</returns>
  3342. <remarks>The connection string</remarks>
  3343. </member>
  3344. <member name="M:Xamarin.UITest.Utils.Integration.IdeConnection.PrepareTestApp">
  3345. <summary>
  3346. Instructs the IDE to prepare the test application for execution, which can include deploying it to the device or simulator
  3347. </summary>
  3348. </member>
  3349. <member name="T:Xamarin.UITest.Utils.IFluentInterface">
  3350. <summary>
  3351. Interface that is used to build fluent interfaces and hides methods declared by <see cref="T:System.Object" /> from IntelliSense.
  3352. </summary>
  3353. <remarks>
  3354. Code that consumes implementations of this interface should expect one of two things:
  3355. <list type="number"><item>When referencing the interface from within the same solution (project reference), you will still see the methods this interface is meant to hide.</item><item>When referencing the interface through the compiled output assembly (external reference), the standard Object methods will be hidden as intended.</item></list>
  3356. See http://bit.ly/ifluentinterface for more information.
  3357. </remarks>
  3358. </member>
  3359. <member name="M:Xamarin.UITest.Utils.IFluentInterface.GetType">
  3360. <summary>
  3361. Redeclaration that hides the <see cref="M:System.Object.GetType" /> method from IntelliSense.
  3362. </summary>
  3363. </member>
  3364. <member name="M:Xamarin.UITest.Utils.IFluentInterface.GetHashCode">
  3365. <summary>
  3366. Redeclaration that hides the <see cref="M:System.Object.GetHashCode" /> method from IntelliSense.
  3367. </summary>
  3368. </member>
  3369. <member name="M:Xamarin.UITest.Utils.IFluentInterface.ToString">
  3370. <summary>
  3371. Redeclaration that hides the <see cref="M:System.Object.ToString" /> method from IntelliSense.
  3372. </summary>
  3373. </member>
  3374. <member name="M:Xamarin.UITest.Utils.IFluentInterface.Equals(System.Object)">
  3375. <summary>
  3376. Redeclaration that hides the <see cref="M:System.Object.Equals(System.Object)" /> method from IntelliSense.
  3377. </summary>
  3378. </member>
  3379. <member name="T:Xamarin.UITest.TestEnvironment">
  3380. <summary>
  3381. Contains runtime information about the current test environment.
  3382. </summary>
  3383. </member>
  3384. <member name="P:Xamarin.UITest.TestEnvironment.Platform">
  3385. <summary>
  3386. Provides the current runtime platform. Useful for complicated test setup scenarios.
  3387. </summary>
  3388. </member>
  3389. <member name="P:Xamarin.UITest.TestEnvironment.IsTestCloud">
  3390. <summary>
  3391. Determines at runtime whether the current test run is in the Xamarin Test Cloud.
  3392. </summary>
  3393. </member>
  3394. <member name="T:Xamarin.UITest.TestPlatform">
  3395. <summary>
  3396. Enum containing the various different test platforms.
  3397. </summary>
  3398. </member>
  3399. <member name="F:Xamarin.UITest.TestPlatform.Local">
  3400. <summary>
  3401. A local test run.
  3402. </summary>
  3403. </member>
  3404. <member name="F:Xamarin.UITest.TestPlatform.TestCloudAndroid">
  3405. <summary>
  3406. An Android test run in the Xamarin Test Cloud.
  3407. </summary>
  3408. </member>
  3409. <member name="F:Xamarin.UITest.TestPlatform.TestCloudiOS">
  3410. <summary>
  3411. An iOS test run in the Xamarin Test Cloud.
  3412. </summary>
  3413. </member>
  3414. <member name="T:Xamarin.UITest.Queries.AppTypedSelector`1">
  3415. <summary>
  3416. Fluent query API for specifying the type in property and invoke result.
  3417. </summary>
  3418. <typeparam name="T">type</typeparam>
  3419. </member>
  3420. <member name="M:Xamarin.UITest.Queries.AppTypedSelector`1.#ctor(Xamarin.UITest.Queries.AppQuery,System.Object[],System.Boolean)">
  3421. <summary>
  3422. Constructor for selectors. Should not be called directly, but used as part of the fluent API in the Property class and for Invoke.
  3423. </summary>
  3424. <param name="appQuery">The query for property</param>
  3425. <param name="queryParams">The parameters passed to the query.</param>
  3426. <param name="explicitlyRequestedValue">
  3427. </param>
  3428. </member>
  3429. <member name="P:Xamarin.UITest.Queries.AppTypedSelector`1.Xamarin#UITest#Queries#ITokenContainer#Tokens">
  3430. <summary>
  3431. The tokens of the current query.
  3432. </summary>
  3433. </member>
  3434. <member name="P:Xamarin.UITest.Queries.AppTypedSelector`1.Xamarin#UITest#Queries#IAppTypedSelector#ExplicitlyRequestedValue">
  3435. <summary>
  3436. The value of the query was explicitly requested.
  3437. </summary>
  3438. </member>
  3439. <member name="M:Xamarin.UITest.Queries.AppTypedSelector`1.ToString">
  3440. <summary>
  3441. Converts the string into it's Calabash query equivalent.
  3442. </summary>
  3443. </member>
  3444. <member name="M:Xamarin.UITest.Queries.AppTypedSelector`1.Invoke(System.String)">
  3445. <summary>
  3446. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  3447. </summary>
  3448. <param name="methodName">The name of the method.</param>
  3449. </member>
  3450. <member name="M:Xamarin.UITest.Queries.AppTypedSelector`1.Invoke(System.String,System.Object)">
  3451. <summary>
  3452. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  3453. </summary>
  3454. <param name="methodName">The name of the method.</param>
  3455. <param name="arg1">The 1st parameter.</param>
  3456. </member>
  3457. <member name="M:Xamarin.UITest.Queries.AppTypedSelector`1.Invoke(System.String,System.Object,System.Object)">
  3458. <summary>
  3459. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  3460. </summary>
  3461. <param name="methodName">The name of the method.</param>
  3462. <param name="arg1">The 1st parameter.</param>
  3463. <param name="arg2">The 2nd parameter.</param>
  3464. </member>
  3465. <member name="M:Xamarin.UITest.Queries.AppTypedSelector`1.Invoke(System.String,System.Object,System.Object,System.Object)">
  3466. <summary>
  3467. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  3468. </summary>
  3469. <param name="methodName">The name of the method.</param>
  3470. <param name="arg1">The 1st parameter.</param>
  3471. <param name="arg2">The 2nd parameter.</param>
  3472. <param name="arg3">The 3rd parameter.</param>
  3473. </member>
  3474. <member name="M:Xamarin.UITest.Queries.AppTypedSelector`1.Invoke(System.String,System.Object,System.Object,System.Object,System.Object)">
  3475. <summary>
  3476. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  3477. </summary>
  3478. <param name="methodName">The name of the method.</param>
  3479. <param name="arg1">The 1st parameter.</param>
  3480. <param name="arg2">The 2nd parameter.</param>
  3481. <param name="arg3">The 3rd parameter.</param>
  3482. <param name="arg4">The 4th parameter.</param>
  3483. </member>
  3484. <member name="M:Xamarin.UITest.Queries.AppTypedSelector`1.Invoke(System.String,System.Object,System.Object,System.Object,System.Object,System.Object)">
  3485. <summary>
  3486. Invokes a method on the view elements matched by the query. Can be chained to invoke methods on the results.
  3487. </summary>
  3488. <param name="methodName">The name of the method.</param>
  3489. <param name="arg1">The 1st parameter.</param>
  3490. <param name="arg2">The 2nd parameter.</param>
  3491. <param name="arg3">The 3rd parameter.</param>
  3492. <param name="arg4">The 4th parameter.</param>
  3493. <param name="arg5">The 5th parameter.</param>
  3494. </member>
  3495. <member name="M:Xamarin.UITest.Queries.AppTypedSelector`1.Value``1">
  3496. <summary>
  3497. Extracts the result of the query as a given type.
  3498. </summary>
  3499. <typeparam name="TResult">The expected result type of the query.</typeparam>
  3500. </member>
  3501. <member name="T:Xamarin.UITest.Utils.Integration.TestRunContext">
  3502. <summary>
  3503. Used to provide information required to run a test suite
  3504. </summary>
  3505. </member>
  3506. <member name="P:Xamarin.UITest.Utils.Integration.TestRunContext.Success">
  3507. <summary>
  3508. When set to False it means that the application preparation failed for some reason. The reason is provided in the
  3509. ErrorMessage property.
  3510. </summary>
  3511. </member>
  3512. <member name="P:Xamarin.UITest.Utils.Integration.TestRunContext.ErrorMessage">
  3513. <summary>
  3514. Message that explains why the test suite can't be executed (when CanExecute == False)
  3515. </summary>
  3516. <value>The error message.</value>
  3517. </member>
  3518. <member name="P:Xamarin.UITest.Utils.Integration.TestRunContext.TestAppDeployed">
  3519. <summary>
  3520. When set to True it means that the test application is already deployed and UITest doesn't have to do it
  3521. ErrorMessage property.
  3522. </summary>
  3523. </member>
  3524. <member name="P:Xamarin.UITest.Utils.Integration.TestRunContext.PackageFile">
  3525. <summary>
  3526. Package to be installed. It overrides the ApkFile or AppBundle option. To be used only if TestAppDeployed==false.
  3527. </summary>
  3528. </member>
  3529. <member name="P:Xamarin.UITest.Utils.Integration.TestRunContext.DeviceId">
  3530. <summary>
  3531. The serial of the device to use for testing
  3532. </summary>
  3533. </member>
  3534. <member name="P:Xamarin.UITest.Utils.Integration.TestRunContext.AppId">
  3535. <summary>
  3536. The app package name (Android), or the bundle id (iOS)
  3537. </summary>
  3538. </member>
  3539. <member name="P:Xamarin.UITest.Utils.Integration.TestRunContext.AndroidKeystoreLocation">
  3540. <summary>
  3541. Location of the Android keystore. If not set, UITest will use the default global keystore. Only for Android.
  3542. </summary>
  3543. </member>
  3544. <member name="P:Xamarin.UITest.Utils.Integration.TestRunContext.AndroidKeyAlias">
  3545. <summary>
  3546. Key store alias. Only for Android.
  3547. </summary>
  3548. </member>
  3549. <member name="P:Xamarin.UITest.Utils.Integration.TestRunContext.AndroidKeystorePassword">
  3550. <summary>
  3551. Key store password. Only for Android.
  3552. </summary>
  3553. </member>
  3554. <member name="P:Xamarin.UITest.Utils.Integration.TestRunContext.AndroidKeyPassword">
  3555. <summary>
  3556. The key password. Only for Android.
  3557. </summary>
  3558. </member>
  3559. <member name="T:Xamarin.UITest.Utils.IWaitTimes">
  3560. <summary>
  3561. Contains default wait times for the framework to use.
  3562. </summary>
  3563. </member>
  3564. <member name="P:Xamarin.UITest.Utils.IWaitTimes.WaitForTimeout">
  3565. <summary>
  3566. Time for the framework to wait when using the WaitFor methods.
  3567. </summary>
  3568. </member>
  3569. <member name="P:Xamarin.UITest.Utils.IWaitTimes.GestureWaitTimeout">
  3570. <summary>
  3571. Time for the framework to wait for elements when performing gestures.
  3572. </summary>
  3573. </member>
  3574. <member name="T:Xamarin.UITest.Utils.RawJson">
  3575. <summary>
  3576. Class for requesting the raw json from the framework.
  3577. </summary>
  3578. </member>
  3579. <member name="M:Xamarin.UITest.Utils.RawJson.#ctor(System.String)">
  3580. <summary>
  3581. Constructs an instance of the RawJson class.
  3582. </summary>
  3583. <param name="json">The json contents.</param>
  3584. </member>
  3585. <member name="P:Xamarin.UITest.Utils.RawJson.Json">
  3586. <summary>
  3587. The contained json.
  3588. </summary>
  3589. </member>
  3590. <member name="M:Xamarin.UITest.Utils.SharedTestServer.Post(System.String,System.Object)">
  3591. <summary>
  3592. Performs an HTTP POST request to the test server.
  3593. </summary>
  3594. <param name="endpoint">The path of the request, which will be appended on the uri of the test server.</param>
  3595. <param name="arguments">An object that will be serialized as json and posted to the test server.</param>
  3596. <returns>The body of the the reponse.</returns>
  3597. </member>
  3598. <member name="M:Xamarin.UITest.Utils.SharedTestServer.Get(System.String)">
  3599. <summary>
  3600. Performs an HTTP GET request to the test server.
  3601. </summary>
  3602. <param name="endpoint">The path of the request, which will be appended on the uri of the test server.</param>
  3603. <returns>The body of the the reponse.</returns>
  3604. </member>
  3605. <member name="M:Xamarin.UITest.Utils.SharedTestServer.Put(System.String,System.Byte[])">
  3606. <summary>
  3607. Performs an HTTP PUT request to the test server.
  3608. </summary>
  3609. <param name="endpoint">The path of the request, which will be appended on the uri of the test server.</param>
  3610. <param name="data">The byte[] data to put.</param>
  3611. <returns>The body of the the reponse.</returns>
  3612. </member>
  3613. <member name="T:Xamarin.UITest.Utils.ReplWaitTimes">
  3614. <summary>
  3615. Default wait times when using the REPL.
  3616. </summary>
  3617. </member>
  3618. <member name="P:Xamarin.UITest.Utils.ReplWaitTimes.WaitForTimeout">
  3619. <summary>
  3620. Time for the framework to wait when using the WaitFor methods.
  3621. </summary>
  3622. </member>
  3623. <member name="P:Xamarin.UITest.Utils.ReplWaitTimes.GestureWaitTimeout">
  3624. <summary>
  3625. Time for the framework to wait for elements when performing gestures.
  3626. </summary>
  3627. </member>
  3628. <member name="T:Xamarin.UITest.ScrollStrategy">
  3629. <summary>
  3630. Strategy for scrolling
  3631. </summary>
  3632. </member>
  3633. <member name="F:Xamarin.UITest.ScrollStrategy.Auto">
  3634. <summary>
  3635. Use any combination of <c>Programmatically</c> and <c>Gesture</c> when trying to scroll. Biased towards <c>Programmatically</c></summary>
  3636. </member>
  3637. <member name="F:Xamarin.UITest.ScrollStrategy.Programmatically">
  3638. <summary>
  3639. Scroll programmatically, will not mimic real user interactions, but are as fast as possible.
  3640. </summary>
  3641. </member>
  3642. <member name="F:Xamarin.UITest.ScrollStrategy.Gesture">
  3643. <summary>
  3644. Scroll using gestures, tries to mimic user interaction as closely as possible.
  3645. </summary>
  3646. </member>
  3647. <member name="T:Xamarin.UITest.Android.UserAction">
  3648. <summary>
  3649. User actions that can be sent to android applications
  3650. </summary>
  3651. </member>
  3652. <member name="F:Xamarin.UITest.Android.UserAction.Normal">
  3653. <summary>
  3654. The normal action.
  3655. </summary>
  3656. </member>
  3657. <member name="F:Xamarin.UITest.Android.UserAction.Unspecified">
  3658. <summary>
  3659. The unspecified action.
  3660. </summary>
  3661. </member>
  3662. <member name="F:Xamarin.UITest.Android.UserAction.None">
  3663. <summary>
  3664. The none action.
  3665. </summary>
  3666. </member>
  3667. <member name="F:Xamarin.UITest.Android.UserAction.Go">
  3668. <summary>
  3669. The go action.
  3670. </summary>
  3671. </member>
  3672. <member name="F:Xamarin.UITest.Android.UserAction.Search">
  3673. <summary>
  3674. The search action.
  3675. </summary>
  3676. </member>
  3677. <member name="F:Xamarin.UITest.Android.UserAction.Send">
  3678. <summary>
  3679. The send action.
  3680. </summary>
  3681. </member>
  3682. <member name="F:Xamarin.UITest.Android.UserAction.Next">
  3683. <summary>
  3684. The next action.
  3685. </summary>
  3686. </member>
  3687. <member name="F:Xamarin.UITest.Android.UserAction.Done">
  3688. <summary>
  3689. The done action.
  3690. </summary>
  3691. </member>
  3692. <member name="F:Xamarin.UITest.Android.UserAction.Previous">
  3693. <summary>
  3694. The previous action.
  3695. </summary>
  3696. </member>
  3697. <member name="T:Xamarin.UITest.Configuration.IdeIntegrationMode">
  3698. <summary>
  3699. IDE integration mode. Decides what settings to use in case of both explicit configuration and active IDE integration.
  3700. </summary>
  3701. </member>
  3702. <member name="F:Xamarin.UITest.Configuration.IdeIntegrationMode.PreferExplicitConfiguration">
  3703. <summary>
  3704. Prefers any explicit configuration choices made by the user as part of configuration.
  3705. </summary>
  3706. </member>
  3707. <member name="F:Xamarin.UITest.Configuration.IdeIntegrationMode.PreferIdeSettingsIfPresent">
  3708. <summary>
  3709. Prefers IDE integration settings if it is active.
  3710. </summary>
  3711. </member>
  3712. <member name="T:Xamarin.UITest.Configuration.AppDataMode">
  3713. <summary>
  3714. Enum for controlling whether or not to clear app data.
  3715. </summary>
  3716. </member>
  3717. <member name="F:Xamarin.UITest.Configuration.AppDataMode.Auto">
  3718. <summary>
  3719. Default behavior depending on platform.
  3720. </summary>
  3721. </member>
  3722. <member name="F:Xamarin.UITest.Configuration.AppDataMode.Clear">
  3723. <summary>
  3724. Always clear app data.
  3725. </summary>
  3726. </member>
  3727. <member name="F:Xamarin.UITest.Configuration.AppDataMode.DoNotClear">
  3728. <summary>
  3729. Never clear app data.
  3730. </summary>
  3731. </member>
  3732. </members>
  3733. </doc>