autodoc.git / modref.xml

version» Context lines:

autodoc.git/modref.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2022-05-25' version='Pike v8.1.17'> + <manual time-stamp='2022-05-29' version='Pike v8.1.17'>    <dir name='./ignored'>    <file name='./ignored/ignored'>    <chapter number='1' title='ignored'>    <autodoc>   <namespace name=''>   <doc><text><p>Symbols implicitly inherited from the virtual base class.</p>   <p> These symbols exist mainly to simplify implementation of    the corresponding lfuns.</p>   </text><group><seealso/><text><p><ref resolved='lfun::'>lfun::</ref></p>   </text></group></doc>
autodoc.git/modref.xml:1747:   <variable name='client_cert_distinguished_names'><type><array><valuetype><string/></valuetype></array></type></variable>   </docgroup>   <docgroup homogen-type='variable'><doc><text><p>Random cookies, sent and received with the hello-messages.</p>   </text></doc>   <variable name='client_random'><type><string/></type></variable>   <variable name='server_random'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='is_server'/><text><p>Whether this is the server end of the connection or not.</p>   </text></group><group><param name='ctx'/><text><p>The context for the connection.</p>   </text></group><group><param name='min_version'/><text><p>Minimum version of SSL to support. -  Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p>   </text></group><group><param name='max_version'/><text><p>Maximum version of SSL to support.    Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>.</p>   </text></group></doc>   <method name='create'>   <arguments><argument name='is_server'><type><int/></type></argument><argument name='ctx'><type><or><void/><object resolved='7.8::SSL.context'>SSL.context</object></or></type></argument><argument name='min_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument><argument name='max_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='handle_handshake' homogen-type='method'><doc><text><p>Do handshake processing. Type is one of HANDSHAKE_*, data is the    contents of the packet, and raw is the raw packet received (needed
autodoc.git/modref.xml:100307:   <docgroup homogen-name='cast' homogen-type='method'><doc><text><p>It is possible to cast a node to a string, which will return    <ref resolved='predef::Parser.XML.Tree.VirtualNode.render_xml'>render_xml()</ref> for that node.</p>   </text></doc>   <method name='cast'><modifiers><protected/></modifiers>   <arguments><argument name='to'><type><string/></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers> - <arguments><argument name='type'><type><int/></type></argument><argument name='name'><type><string/></type></argument><argument name='attr'><type><or><mapping/><zero/></or></type></argument><argument name='text'><type><or><string/><zero/></or></type></argument></arguments> + <arguments><argument name='type'><type><int/></type></argument><argument name='name'><type><or><string/><zero/></or></type></argument><argument name='attr'><type><or><mapping/><zero/></or></type></argument><argument name='text'><type><or><string/><zero/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='get_any_name' homogen-type='method'><doc><text><p>Return name of tag or name of attribute node.</p>   </text></doc>   <method name='get_any_name'>   <arguments/>   <returntype><string/></returntype>   </method>   </docgroup>
autodoc.git/modref.xml:106132:   <method name='thread_request'>   <arguments><argument name='server'><type><string/></type></argument><argument name='port'><type><int/></type></argument><argument name='query'><type><string/></type></argument><argument name='headers'><type><mapping/></type></argument><argument name='data'><type><or><void/><string/></or></type></argument></arguments>   <returntype><object resolved='predef::Protocols.HTTP.Query'>Protocols.HTTP.Query</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='timed_async_fetch' homogen-type='method'><doc><text><p>Like <ref resolved='predef::Protocols.HTTP.Query.async_fetch'>async_fetch()</ref>, except with a timeout and a corresponding fail    callback function.</p>   </text><group><seealso/><text><p><ref resolved='predef::Protocols.HTTP.Query.async_fetch'>async_fetch()</ref>, <ref resolved='predef::Protocols.HTTP.Query.async_request'>async_request()</ref>, <ref resolved='predef::Protocols.HTTP.Query.set_callbacks'>set_callbacks()</ref></p>   </text></group></doc>   <method name='timed_async_fetch'> - <arguments><argument name='ok_callback'><type><function><argtype><object resolved='predef::Protocols.HTTP.Query.timed_async_fetch'/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><void/></returntype></function></type></argument><argument name='fail_callback'><type><function><argtype><object resolved='predef::Protocols.HTTP.Query.timed_async_fetch'/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><void/></returntype></function></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments> + <arguments><argument name='ok_callback'><type><function><argtype><object resolved='predef::Protocols.HTTP.Query'>this_program</object></argtype><argtype><varargs><object>__unknown__</object></varargs></argtype><returntype><void/></returntype></function></type></argument><argument name='fail_callback'><type><function><argtype><object resolved='predef::Protocols.HTTP.Query'>this_program</object></argtype><argtype><varargs><object>__unknown__</object></varargs></argtype><returntype><void/></returntype></function></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='total_bytes' homogen-type='method'><doc><text><p>Gives back the size of a file if a content-length header is present    and parsed at the time of evaluation. Otherwise returns -1.</p>   </text></doc>   <method name='total_bytes'>   <arguments/>   <returntype><int/></returntype>   </method>
autodoc.git/modref.xml:138113:   <docgroup homogen-name='ACCESS_TOKEN_PARAM_NAME' homogen-type='constant'><doc><text><p>In some API's (LinkedIn f ex) this is named something else so it needs    to be overridden i cases where it has a different name than the    standard one.</p>   </text><group><note/><text><p>Obsolete.</p>   <p> This is only used if <ref resolved='predef::Web.Api.Api.AUTHORIZATION_METHOD'>AUTHORIZATION_METHOD</ref> has been set to <expr>""</expr>.</p>   </text></group></doc>   <constant name='ACCESS_TOKEN_PARAM_NAME'><modifiers><protected/></modifiers><type><string/></type></constant>   </docgroup>   <docgroup homogen-name='API_URI' homogen-type='constant'><doc><text><p>The default URI to the remote API</p>   </text></doc> - <constant name='API_URI'><type><int/></type></constant> + <constant name='API_URI'><type><string/></type></constant>   </docgroup>   <docgroup homogen-name='AUTHORIZATION_METHOD' homogen-type='constant'><doc><text><p>Authorization header prefix.</p>   <p> This is typically <expr>"Bearer"</expr> as per <rfc>6750</rfc>, but    some apis use the older <expr>"token"</expr>.</p>   </text></doc>   <constant name='AUTHORIZATION_METHOD'><modifiers><protected/></modifiers><type><string/></type></constant>   </docgroup>   <docgroup homogen-name='AuthClass' homogen-type='constant'><doc><text><p>Authentication class to use</p>   </text></doc>   <constant name='AuthClass'/>
autodoc.git/modref.xml:139029:   <docgroup homogen-name='media' homogen-type='variable'><doc><text><p>Getter for the <ref resolved='predef::Web.Api.Instagram.V1.Media'>Media</ref> object which has methods for all <expr>media</expr>    related Instagram API methods.</p>   </text><group><seealso/><text><p><url>http://instagram.com/developer/endpoints/media/</url></p>   </text></group><group><note/><text><p>Read only</p>   </text></group></doc>   <variable name='media'><type><object resolved='predef::Web.Api.Instagram.V1.Media'>Media</object></type></variable>   </docgroup>   <docgroup homogen-name='post' homogen-type='method'><doc><text><p>Make a generic <expr>POST</expr> request to the Instagram API.</p>   </text><group><param name='path'/><text><p>What to request. Like <expr>me</expr>, <expr>users/self</expr>,    <expr>[some_id]/something</expr>.</p> - </text></group><group><param name='params'/></group><group><param name='data'/></group><group><param name='cb'/><text><p>Callback for async requests</p> + </text></group><group><param name='params'/></group><group><param name='data'/><text><p>Ignored.</p> + </text></group><group><param name='cb'/><text><p>Callback for async requests</p>   </text></group></doc>   <method name='post'> - <arguments><argument name='path'><type><string/></type></argument><argument name='params'><type><or><void/><object resolved='predef::Web.Api.Api.ParamsArg'>ParamsArg</object></or></type></argument><argument name='data'><type><string/></type></argument><argument name='cb'><type><or><void/><object resolved='predef::Web.Api.Api.Callback'>Callback</object></or></type></argument></arguments> + <arguments><argument name='path'><type><string/></type></argument><argument name='params'><type><or><void/><object resolved='predef::Web.Api.Api.ParamsArg'>ParamsArg</object></or></type></argument><argument name='data'><type><or><string/><zero/></or></type></argument><argument name='cb'><type><or><void/><object resolved='predef::Web.Api.Api.Callback'>Callback</object></or></type></argument></arguments>   <returntype><mapping/></returntype>   </method>   </docgroup>   <docgroup homogen-name='put' homogen-type='method'><doc><text><p>Make a generic <expr>PUT</expr> request to the Instagram API.</p>   </text><group><param name='path'/><text><p>What to request. Like <expr>me</expr>, <expr>users/self</expr>,    <expr>[some_id]/something</expr>.</p>   </text></group><group><param name='params'/></group><group><param name='cb'/><text><p>Callback for async requests</p>   </text></group></doc>   <method name='put'>   <arguments><argument name='path'><type><string/></type></argument><argument name='params'><type><or><void/><object resolved='predef::Web.Api.Api.ParamsArg'>ParamsArg</object></or></type></argument><argument name='cb'><type><or><void/><object resolved='predef::Web.Api.Api.Callback'>Callback</object></or></type></argument></arguments>
autodoc.git/modref.xml:139094:   </docgroup>   <docgroup homogen-name='Method' homogen-type='inherit'>   <inherit name='Method'><classname resolved='predef::Web.Api.Instagram.V1.Method'>Method</classname></inherit>   </docgroup>   <docgroup homogen-name='post' homogen-type='method'><doc><text><p>POST data</p>   </text><group><param name='s'/><text><p>The path to the Instagram API to query</p>   </text></group><group><param name='p'/><text><p>Parameters to the query</p>   </text></group><group><param name='cb'/><text><p>Async callback</p>   </text></group></doc>   <method name='post'> - <arguments><argument name='s'><type><string/></type></argument><argument name='p'><type><or><void/><object resolved='predef::Web.Api.Api.ParamsArg'>ParamsArg</object></or></type></argument><argument name='data'><type><string/></type></argument><argument name='cb'><type><or><void/><object resolved='predef::Web.Api.Api.Callback'>Callback</object></or></type></argument></arguments> + <arguments><argument name='s'><type><string/></type></argument><argument name='p'><type><or><void/><object resolved='predef::Web.Api.Api.ParamsArg'>ParamsArg</object></or></type></argument><argument name='data'><type><or><string/><zero/></or></type></argument><argument name='cb'><type><or><void/><object resolved='predef::Web.Api.Api.Callback'>Callback</object></or></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup>   <docgroup homogen-name='put' homogen-type='method'><doc><text><p>PUT data</p>   </text><group><param name='s'/><text><p>The path to the Instagram API to query</p>   </text></group><group><param name='p'/><text><p>Parameters to the query</p>   </text></group><group><param name='cb'/><text><p>Async callback</p>   </text></group></doc>   <method name='put'>   <arguments><argument name='s'><type><string/></type></argument><argument name='p'><type><or><void/><object resolved='predef::Web.Api.Api.ParamsArg'>ParamsArg</object></or></type></argument><argument name='cb'><type><or><void/><object resolved='predef::Web.Api.Api.Callback'>Callback</object></or></type></argument></arguments>
autodoc.git/modref.xml:139312:   <docgroup homogen-name='_get' homogen-type='method'><doc><text><p>Internal convenience method</p>   </text></doc>   <method name='_get'><modifiers><protected/></modifiers>   <arguments><argument name='s'><type><string/></type></argument><argument name='p'><type><or><void/><object resolved='predef::Web.Api.Api.ParamsArg'>ParamsArg</object></or></type></argument><argument name='cb'><type><or><void/><object resolved='predef::Web.Api.Api.Callback'>Callback</object></or></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup>   <docgroup homogen-name='_post' homogen-type='method'><doc><text><p>Internal convenience method</p>   </text></doc>   <method name='_post'><modifiers><protected/></modifiers> - <arguments><argument name='s'><type><string/></type></argument><argument name='p'><type><or><void/><object resolved='predef::Web.Api.Api.ParamsArg'>ParamsArg</object></or></type></argument><argument name='data'><type><string/></type></argument><argument name='cb'><type><or><void/><object resolved='predef::Web.Api.Api.Callback'>Callback</object></or></type></argument></arguments> + <arguments><argument name='s'><type><string/></type></argument><argument name='p'><type><or><void/><object resolved='predef::Web.Api.Api.ParamsArg'>ParamsArg</object></or></type></argument><argument name='data'><type><or><string/><zero/></or></type></argument><argument name='cb'><type><or><void/><object resolved='predef::Web.Api.Api.Callback'>Callback</object></or></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup>   <docgroup homogen-name='_put' homogen-type='method'><doc><text><p>Internal convenience method</p>   </text></doc>   <method name='_put'><modifiers><protected/></modifiers>   <arguments><argument name='s'><type><string/></type></argument><argument name='p'><type><or><void/><object resolved='predef::Web.Api.Api.ParamsArg'>ParamsArg</object></or></type></argument><argument name='cb'><type><or><void/><object resolved='predef::Web.Api.Api.Callback'>Callback</object></or></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup>
autodoc.git/modref.xml:140085:   </method>   </docgroup>   <class name='Authentication'>   <doc><text><p>The purpose of this class is to streamline OAuth1 with OAuth2.    This class will not do much on it's own, since its purpose is to    be inherited by some other class implementing a specific authorization    service.</p>   </text></doc>   <docgroup homogen-name='ACCESS_TOKEN_URL' homogen-type='constant'><doc><text><p>The endpoint to send request for an access token.</p>   </text></doc> - <constant name='ACCESS_TOKEN_URL'><type><int/></type></constant> + <constant name='ACCESS_TOKEN_URL'><type><string/></type></constant>   </docgroup>   <docgroup homogen-name='REQUEST_TOKEN_URL' homogen-type='constant'><doc><text><p>The endpoint to send request for a request token.</p>   </text></doc> - <constant name='REQUEST_TOKEN_URL'><type><int/></type></constant> + <constant name='REQUEST_TOKEN_URL'><type><string/></type></constant>   </docgroup>   <docgroup homogen-name='USER_AUTH_URL' homogen-type='constant'><doc><text><p>The enpoint to redirect to when authorize an application.</p>   </text></doc> - <constant name='USER_AUTH_URL'><type><int/></type></constant> + <constant name='USER_AUTH_URL'><type><string/></type></constant>   </docgroup>   <docgroup homogen-name='call' homogen-type='method'><doc><text><p>Does the low level HTTP call to a service.</p>   </text><group><throws/><text><p>An error if HTTP status != 200</p>   </text></group><group><param name='url'/><text><p>The full address to the service e.g:    <tt>http://twitter.com/direct_messages.xml</tt></p>   </text></group><group><param name='args'/><text><p>Arguments to send with the request</p>   </text></group><group><param name='mehod'/><text><p>The HTTP method to use</p>   </text></group></doc>   <method name='call'>   <arguments><argument name='url'><type><or><string/><object resolved='predef::Standards.URI'>Standards.URI</object></or></type></argument><argument name='args'><type><or><void/><mapping/><object resolved='predef::Web.Auth.OAuth.Params'>.Params</object></or></type></argument><argument name='method'><type><or><void/><string/></or></type></argument></arguments>
autodoc.git/modref.xml:140873:   <docgroup homogen-name='do_query' homogen-type='method'><doc><text><p>Send a request to <ref resolved='predef::Web.Auth.OAuth2.Base.do_query.oauth_token_uri'>oauth_token_uri</ref> with params <ref resolved='predef::Web.Auth.OAuth2.Base.do_query.p'>p</ref></p>   </text><group><param name='async_cb'/><text><p>If given an async request will be made and this function will    be called when the request is finished. The first argument    passed to the callback will be <expr>true</expr> or <expr>false</expr>    depending on if the request was successfull or not. The second    argument will be a string. If the request failed it will be an    error message. If it succeeded it will be the result as a    string encoded with <ref resolved='predef::encode_value'>predef::encode_value()</ref>.</p>   </text></group></doc>   <method name='do_query'><modifiers><protected/></modifiers> - <arguments><argument name='oauth_token_uri'><type><string/></type></argument><argument name='p'><type><object resolved='predef::Web.Auth.Params'>Web.Auth.Params</object></type></argument><argument name='async_cb'><type><or><void/><function><argtype><object resolved='predef::bool'>bool</object></argtype><argtype><string/></argtype><returntype><void/></returntype></function></or></type></argument></arguments> + <arguments><argument name='oauth_token_uri'><type><or><string/><zero/></or></type></argument><argument name='p'><type><object resolved='predef::Web.Auth.Params'>Web.Auth.Params</object></type></argument><argument name='async_cb'><type><or><void/><function><argtype><object resolved='predef::bool'>bool</object></argtype><argtype><string/></argtype><returntype><void/></returntype></function></or></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup>   <docgroup homogen-name='expires' homogen-type='variable'><doc><text><p>Getter for when the authentication <expr>expires</expr>.</p>   </text><group><note/><text><p>Read only</p>   </text></group></doc>   <variable name='expires'><type><object>Calendar.Second</object></type></variable>   </docgroup>   <docgroup homogen-name='get_access_type' homogen-type='method'><doc><text><p>Getter for the access type, if any.</p>   </text></doc>
autodoc.git/modref.xml:141021:   </text><group><param name='oauth_token_uri'/><text><p>Endpoint of the authentication service.</p>   </text></group><group><param name='async_cb'/><text><p>If given an async request will be made and this function will    be called when the request is finished. The first argument    passed to the callback will be <expr>true</expr> or <expr>false</expr>    depending on if the request was successfull or not. The second    argument will be a string. If the request failed it will be an    error message. If it succeeded it will be the result as a    string encoded with <ref resolved='predef::encode_value'>predef::encode_value()</ref>.</p>   </text></group></doc>   <method name='refresh_access_token'> - <arguments><argument name='oauth_token_uri'><type><string/></type></argument><argument name='async_cb'><type><or><void/><function><argtype><object resolved='predef::bool'>bool</object></argtype><argtype><string/></argtype><returntype><void/></returntype></function></or></type></argument></arguments> + <arguments><argument name='oauth_token_uri'><type><or><string/><zero/></or></type></argument><argument name='async_cb'><type><or><void/><function><argtype><object resolved='predef::bool'>bool</object></argtype><argtype><string/></argtype><returntype><void/></returntype></function></or></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup>   <docgroup homogen-name='refresh_token' homogen-type='variable'><doc><text><p>Getter for <expr>refresh_token</expr>.</p>   </text><group><note/><text><p>Read only</p>   </text></group></doc>   <variable name='refresh_token'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='request_access_token' homogen-type='method'><doc><text><p>Requests an access token.</p>   </text><group><throws/><text><p>An error if the access token request fails.</p>
autodoc.git/modref.xml:141049:    error message. If it succeeded it will be the result as a    string encoded with <ref resolved='predef::encode_value'>predef::encode_value()</ref>.</p>   </text></group><group><returns/><text><p>If <expr>OK</expr> a Pike encoded mapping (i.e it's a string) is    returned which can be used to populate an <ref resolved='predef::Web.Auth.OAuth2'>Web.Auth.OAuth2</ref>    object at a later time.</p>   <p> The mapping looks like</p>   <mapping><group><member><type><string/></type><index>"access_token"</index></member><member><type><int/></type><index>"expires"</index></member><member><type><int/></type><index>"created"</index></member><member><type><string/></type><index>"refresh_token"</index></member><member><type><string/></type><index>"token_type"</index></member></group></mapping><p>Depending on the authorization service it might also contain more    members.</p>   </text></group></doc>   <method name='request_access_token'> - <arguments><argument name='oauth_token_uri'><type><string/></type></argument><argument name='code'><type><string/></type></argument><argument name='async_cb'><type><or><void/><function><argtype><object resolved='predef::bool'>bool</object></argtype><argtype><string/></argtype><returntype><void/></returntype></function></or></type></argument></arguments> + <arguments><argument name='oauth_token_uri'><type><or><string/><zero/></or></type></argument><argument name='code'><type><string/></type></argument><argument name='async_cb'><type><or><void/><function><argtype><object resolved='predef::bool'>bool</object></argtype><argtype><string/></argtype><returntype><void/></returntype></function></or></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup>   <docgroup homogen-name='request_headers' homogen-type='variable'><doc><text><p>Default request headers.</p>   </text></doc>   <variable name='request_headers'><modifiers><protected/></modifiers><type><mapping/></type></variable>   </docgroup>   <docgroup homogen-name='set_access_type' homogen-type='method'><doc><text><p>Set access_type explicilty.</p>   </text><group><param name='access_type'/><text><p>Like: offline</p>   </text></group></doc>