|
| 1 | +<?xml version="1.0" encoding="utf-8" standalone="yes"?> |
| 2 | +<doc> |
| 3 | + <members> |
| 4 | + <assembly> |
| 5 | + <name>UnityEngine.Advertisements</name> |
| 6 | + </assembly> |
| 7 | + <member name="T:UnityEngine.Advertisements.Advertisement"> |
| 8 | + <summary> |
| 9 | + <para>Unity Ads.</para> |
| 10 | + </summary> |
| 11 | + </member> |
| 12 | + <member name="P:UnityEngine.Advertisements.Advertisement.debugLevel"> |
| 13 | + <summary> |
| 14 | + <para>Controls the amount of logging output from the advertisement system.</para> |
| 15 | + </summary> |
| 16 | + </member> |
| 17 | + <member name="P:UnityEngine.Advertisements.Advertisement.gameId"> |
| 18 | + <summary> |
| 19 | + <para>Returns the game identifier for the current platform.</para> |
| 20 | + </summary> |
| 21 | + </member> |
| 22 | + <member name="P:UnityEngine.Advertisements.Advertisement.isInitialized"> |
| 23 | + <summary> |
| 24 | + <para>Returns whether the advertisement system is initialized successfully.</para> |
| 25 | + </summary> |
| 26 | + </member> |
| 27 | + <member name="P:UnityEngine.Advertisements.Advertisement.isShowing"> |
| 28 | + <summary> |
| 29 | + <para>Returns whether an advertisement is currently being shown.</para> |
| 30 | + </summary> |
| 31 | + </member> |
| 32 | + <member name="P:UnityEngine.Advertisements.Advertisement.isSupported"> |
| 33 | + <summary> |
| 34 | + <para>Returns if the current platform is supported by the advertisement system.</para> |
| 35 | + </summary> |
| 36 | + </member> |
| 37 | + <member name="P:UnityEngine.Advertisements.Advertisement.testMode"> |
| 38 | + <summary> |
| 39 | + <para>Returns whether the testing mode is enabled.</para> |
| 40 | + </summary> |
| 41 | + </member> |
| 42 | + <member name="T:UnityEngine.Advertisements.Advertisement.DebugLevel"> |
| 43 | + <summary> |
| 44 | + <para>Player debug message level.</para> |
| 45 | + </summary> |
| 46 | + </member> |
| 47 | + <member name="F:UnityEngine.Advertisements.Advertisement.DebugLevel.Debug"> |
| 48 | + <summary> |
| 49 | + <para>Prints all debugging messages.</para> |
| 50 | + </summary> |
| 51 | + </member> |
| 52 | + <member name="F:UnityEngine.Advertisements.Advertisement.DebugLevel.Error"> |
| 53 | + <summary> |
| 54 | + <para>Prints all error messages.</para> |
| 55 | + </summary> |
| 56 | + </member> |
| 57 | + <member name="F:UnityEngine.Advertisements.Advertisement.DebugLevel.Info"> |
| 58 | + <summary> |
| 59 | + <para>Prints all informational messages.</para> |
| 60 | + </summary> |
| 61 | + </member> |
| 62 | + <member name="F:UnityEngine.Advertisements.Advertisement.DebugLevel.None"> |
| 63 | + <summary> |
| 64 | + <para>Prints out no debugging output.</para> |
| 65 | + </summary> |
| 66 | + </member> |
| 67 | + <member name="F:UnityEngine.Advertisements.Advertisement.DebugLevel.Warning"> |
| 68 | + <summary> |
| 69 | + <para>Prints out warnings.</para> |
| 70 | + </summary> |
| 71 | + </member> |
| 72 | + <member name="M:UnityEngine.Advertisements.Advertisement.Initialize(System.String)"> |
| 73 | + <summary> |
| 74 | + <para>Manually initializes the advertisement system. Normally this is done from editor, and you should only call this method if you have disabled UnityAds from the Editor settings in Connect window.</para> |
| 75 | + </summary> |
| 76 | + <param name="appId">Your game id. You can see a list of your registered games at the UnityAds admin site.</param> |
| 77 | + <param name="testMode">In test mode, you will see test advertisement. Can be overruled by settings in the admin site for game.</param> |
| 78 | + </member> |
| 79 | + <member name="M:UnityEngine.Advertisements.Advertisement.Initialize(System.String,System.Boolean)"> |
| 80 | + <summary> |
| 81 | + <para>Manually initializes the advertisement system. Normally this is done from editor, and you should only call this method if you have disabled UnityAds from the Editor settings in Connect window.</para> |
| 82 | + </summary> |
| 83 | + <param name="appId">Your game id. You can see a list of your registered games at the UnityAds admin site.</param> |
| 84 | + <param name="testMode">In test mode, you will see test advertisement. Can be overruled by settings in the admin site for game.</param> |
| 85 | + </member> |
| 86 | + <member name="M:UnityEngine.Advertisements.Advertisement.IsReady"> |
| 87 | + <summary> |
| 88 | + <para>Returns whether an advertisement is ready to be shown. Zones are configured per game in the UnityAds admin site, where you can also set your default zone.</para> |
| 89 | + </summary> |
| 90 | + <param name="zoneId">Optional zone identifier. If not specified, your default zone specified in UnityAds server-side admin settings will be used.</param> |
| 91 | + </member> |
| 92 | + <member name="M:UnityEngine.Advertisements.Advertisement.IsReady(System.String)"> |
| 93 | + <summary> |
| 94 | + <para>Returns whether an advertisement is ready to be shown. Zones are configured per game in the UnityAds admin site, where you can also set your default zone.</para> |
| 95 | + </summary> |
| 96 | + <param name="zoneId">Optional zone identifier. If not specified, your default zone specified in UnityAds server-side admin settings will be used.</param> |
| 97 | + </member> |
| 98 | + <member name="M:UnityEngine.Advertisements.Advertisement.Show"> |
| 99 | + <summary> |
| 100 | + <para>Show an advertisement in your project.</para> |
| 101 | + </summary> |
| 102 | + <param name="zoneId">Optional zone identifier. If not specified, your default zone specified in the admin settings will be used.</param> |
| 103 | + <param name="options">Specify e.g. callback handler to be called when video has finished.</param> |
| 104 | + </member> |
| 105 | + <member name="M:UnityEngine.Advertisements.Advertisement.Show(System.String)"> |
| 106 | + <summary> |
| 107 | + <para>Show an advertisement in your project.</para> |
| 108 | + </summary> |
| 109 | + <param name="zoneId">Optional zone identifier. If not specified, your default zone specified in the admin settings will be used.</param> |
| 110 | + <param name="options">Specify e.g. callback handler to be called when video has finished.</param> |
| 111 | + </member> |
| 112 | + <member name="M:UnityEngine.Advertisements.Advertisement.Show(System.String,UnityEngine.Advertisements.ShowOptions)"> |
| 113 | + <summary> |
| 114 | + <para>Show an advertisement in your project.</para> |
| 115 | + </summary> |
| 116 | + <param name="zoneId">Optional zone identifier. If not specified, your default zone specified in the admin settings will be used.</param> |
| 117 | + <param name="options">Specify e.g. callback handler to be called when video has finished.</param> |
| 118 | + </member> |
| 119 | + <member name="T:UnityEngine.Advertisements.ShowOptions"> |
| 120 | + <summary> |
| 121 | + <para>Collection of options that can be passed to [[Advertisements.Show]] to modify advertisement behaviour.</para> |
| 122 | + </summary> |
| 123 | + </member> |
| 124 | + <member name="P:UnityEngine.Advertisements.ShowOptions.gamerSid"> |
| 125 | + <summary> |
| 126 | + <para>Add a string to specify an identifier for a specific user in the game.</para> |
| 127 | + </summary> |
| 128 | + </member> |
| 129 | + <member name="P:UnityEngine.Advertisements.ShowOptions.resultCallback"> |
| 130 | + <summary> |
| 131 | + <para>Callback to recieve the result of the advertisement.</para> |
| 132 | + </summary> |
| 133 | + </member> |
| 134 | + <member name="T:UnityEngine.Advertisements.ShowResult"> |
| 135 | + <summary> |
| 136 | + <para>ShowResult is passed to [[ShowOptions.resultCallback]] after the advertisement has completed.</para> |
| 137 | + </summary> |
| 138 | + </member> |
| 139 | + <member name="F:UnityEngine.Advertisements.ShowResult.Failed"> |
| 140 | + <summary> |
| 141 | + <para>Indicates that the advertisement failed to complete.</para> |
| 142 | + </summary> |
| 143 | + </member> |
| 144 | + <member name="F:UnityEngine.Advertisements.ShowResult.Finished"> |
| 145 | + <summary> |
| 146 | + <para>Indicates that the advertisement completed successfully.</para> |
| 147 | + </summary> |
| 148 | + </member> |
| 149 | + <member name="F:UnityEngine.Advertisements.ShowResult.Skipped"> |
| 150 | + <summary> |
| 151 | + <para>Indicates that the advertisement was skipped.</para> |
| 152 | + </summary> |
| 153 | + </member> |
| 154 | + </members> |
| 155 | +</doc> |
0 commit comments