Prefix:4.0.0
-Suffix:preview1-00107
-Number:107
-VCS:e2fe82f9ef4f40d1f09ab0a6da27f07f8904ecbd
+Suffix:preview1-00111
+Number:111
+VCS:bd562f15495a891a9feefc0164457a204599b799
<members>
<member name="M:Interop.Libteec.InitializeContext(System.String,Interop.TEEC_Context@)">
<summary>
- This function initializes a new TEE Context, forming a connection between this Client Application and the
+ This function initializes a new TEE Context, forming a connection between this client application and the
TEE identified by the string identifier name.
- The Client Application MAY pass name with a value of NULL, which means that the Implementation MUST
+ The client application may pass a name with a value of null, which means that the implementation must
select a default TEE to connect to. The supported name strings, the mapping of these names to a specific
TEE, and the nature of the default TEE are implementation-defined.
</summary>
</member>
<member name="M:Interop.Libteec.FinalizeContext(Interop.TEEC_Context@)">
<summary>
- This function destroys an initialized TEE Context, closing the connection between the Client Application
- and the TEE. The Client Application MUST only call this function when all Sessions inside this TEE
- Context have been closed and all Shared Memory blocks have been released.
- The implementation of this function MUST NOT be able to fail; after this function returns the Client
- Application must be able to consider that the Context has been closed.
- The function implementation MUST do nothing if the value of the context pointer is NULL.
+ This function destroys an initialized TEE Context, closing the connection between the client application
+ and the TEE. The client application must only call this function when all sessions inside this TEE
+ context have been closed and all shared memory blocks have been released.
+ The implementation of this function must not fail; after this function returns, the client
+ application must be able to consider that the context has been closed.
+ The function implementation must do nothing if the value of the context pointer is null.
</summary>
</member>
<member name="M:Interop.Libteec.RegisterSharedMemory(Interop.TEEC_Context@,Interop.TEEC_SharedMemory@)">
<summary>
- This function registers a block of existing Client Application memory as a block of Shared Memory within
+ This function registers a block of existing client application memory as a block of shared memory within
the scope of the specified TEE Context, in accordance with the parameters which have been set by the
- Client Application inside the sharedMem structure.
- The input context MUST point to an initialized TEE Context.
- The input sharedMem MUST point to the Shared Memory structure defining the memory region to register
+ client application inside the shared memory structure.
+ The input context must point to an initialized TEE Context.
+ The input shared Memory must point to the shared memory structure defining the memory region to register.
</summary>
</member>
<member name="M:Interop.Libteec.AllocateSharedMemory(Interop.TEEC_Context@,Interop.TEEC_SharedMemory@)">
<summary>
- This function allocates a new block of memory as a block of Shared Memory within the scope of the
- specified TEE Context, in accordance with the parameters which have been set by the Client Application
- inside the sharedMem structure.
- The input context MUST point to an initialized TEE Context.
- The input sharedMem MUST point to the Shared Memory structure defining the region to allocate.
+ This function allocates a new block of memory as a block of shared memory within the scope of the
+ specified TEE Context, in accordance with the parameters which have been set by the client application
+ inside the shared memory structure.
+ The input context must point to an initialized TEE Context.
+ The input shared memory must point to the shared memory structure defining the region to allocate.
</summary>
</member>
<member name="M:Interop.Libteec.ReleaseSharedMemory(Interop.TEEC_SharedMemory@)">
<summary>
- This function deregisters or deallocates a previously initialized block of Shared Memory.
- For a memory buffer allocated using AllocateSharedMemory the Implementation MUST free the
- underlying memory and the Client Application MUST NOT access this region after this function has been
- called. In this case the Implementation MUST set the buffer and size fields of the sharedMem
- structure to NULL and 0 respectively before returning.
- For memory registered using RegisterSharedMemory the implementation MUST deregister the
- underlying memory from the TEE, but the memory region will stay available to the Client Application for
+ This function deregisters or deallocates a previously initialized block of the shared memory.
+ For a memory buffer allocated using AllocateSharedMemory, the implementation must free the
+ underlying memory and the client application must not access this region after this function has been
+ called. In this case, the implementation must set the buffer and size fields of the shared memory
+ structure to null and 0 respectively before returning.
+ For memory registered using RegisterSharedMemory, the implementation must deregister the
+ underlying memory from the TEE, but the memory region will stay available to the client application for
other purposes as the memory is owned by it.
- The implementation MUST do nothing if the value of the sharedMem parameter is NULL.
+ The implementation must do nothing if the value of the shared memory parameter is null.
</summary>
</member>
<member name="M:Interop.Libteec.OpenSession(Interop.TEEC_Context@,Interop.TEEC_Session@,Interop.TEEC_UUID,System.UInt32,System.Byte[],Interop.TEEC_Operation@,System.UInt32@)">
<summary>
- This function opens a new Session between the Client Application and the specified Trusted Application.
- The Implementation MUST assume that all fields of this session structure are in an undefined state.
- When this function returns TEEC_SUCCESS the Implementation MUST have populated this structure with
- any information necessary for subsequent operations within the Session.
- The target Trusted Application is identified by a UUID passed in the parameter destination.
+ This function opens a new session between the client application and the specified trusted application.
+ The implementation must assume that all fields of this session structure are in an undefined state.
+ When this function returns TEEC_SUCCESS, the implementation must have populated this structure with
+ any information necessary for subsequent operations within the session.
+ The target trusted application is identified by the UUID passed in the parameter destination.
</summary>
</member>
<member name="M:Interop.Libteec.CloseSession(Interop.TEEC_Session@)">
<summary>
- This function closes a Session which has been opened with a Trusted Application.
- All Commands within the Session MUST have completed before this function can be called.
- The Implementation MUST do nothing if the input session parameter is NULL.
- The implementation of this function MUST NOT be able to fail; after this function returns the Client
- Application must be able to consider that the Session has been closed.
+ This function closes a session which has been opened with a trusted application.
+ All commands within the session must have completed before this function can be called.
+ The implementation must do nothing if the input session parameter is null.
+ The implementation of this function must not fail; after this function returns, the Client
+ Application must be able to consider that the session has been closed.
</summary>
</member>
<member name="M:Interop.Libteec.InvokeCommand(Interop.TEEC_Session@,System.UInt32,Interop.TEEC_Operation@,System.UInt32@)">
<summary>
- This function invokes a Command within the specified Session.
- The parameter session MUST point to a valid open Session.
+ This function invokes a command within the specified session.
+ The parameter session must point to a valid open session.
The parameter commandID is an identifier that is used to indicate which of the exposed Trusted
Application functions should be invoked. The supported command identifier values are defined by the
- Trusted Application‟s protocol.
+ trusted application's protocol.
</summary>
</member>
<member name="M:Interop.Libteec.RequestCancellation(Interop.TEEC_Operation@)">
<summary>
- This function requests the cancellation of a pending open Session operation or a Command invocation
+ This function requests the cancelation of a pending open session operation or a command invocation
operation. As this is a synchronous API, this function must be called from a thread other than the one
executing the OpenSession or InvokeCommand function.
- This function just sends a cancellation signal to the TEE and returns immediately; the operation is not
- guaranteed to have been cancelled when this function returns. In addition, the cancellation request is just
- a hint; the TEE or the Trusted Application MAY ignore the cancellation request.
+ This function just sends a cancelation signal to the TEE and returns immediately; the operation is not
+ guaranteed to have been canceled when this function returns. In addition, the cancelation request is just
+ a hint; the TEE or the trusted application may ignore the cancelation request.
</summary>
</member>
<member name="T:Tizen.Security.TEEC.LoginMethod">
<summary>
- This type denotes Session Login Method used in OpenSession
+ This type denotes the Session Login Method used in OpenSession.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<summary>No login data is provided.</summary>
</member>
<member name="F:Tizen.Security.TEEC.LoginMethod.User">
- <summary>Login data about the user running the Client Application process is provided.</summary>
+ <summary>Login data about the user running the client application process is provided.</summary>
</member>
<member name="F:Tizen.Security.TEEC.LoginMethod.Group">
- <summary>Login data about the group running the Client Application process is provided.</summary>
+ <summary>Login data about the group running the client application process is provided.</summary>
</member>
<member name="F:Tizen.Security.TEEC.LoginMethod.Application">
- <summary>Login data about the running Client Application itself is provided.</summary>
+ <summary>Login data about the running client application itself is provided.</summary>
</member>
<member name="T:Tizen.Security.TEEC.TEFValueType">
<summary>
- This type denotes Value parameter
+ This type denotes the Value parameter.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Security.TEEC.TEFValueType.Input">
- <summary>The Parameter is a ValueType tagged as input.</summary>
+ <summary>The parameter is a ValueType tagged as the input.</summary>
</member>
<member name="F:Tizen.Security.TEEC.TEFValueType.Output">
- <summary>The Parameter is a ValueType tagged as output.</summary>
+ <summary>The parameter is a ValueType tagged as the output.</summary>
</member>
<member name="F:Tizen.Security.TEEC.TEFValueType.InOut">
- <summary>The Parameter is a ValueType tagged as both as input and output.</summary>
+ <summary>The parameter is a ValueType tagged as both the input and the output.</summary>
</member>
<member name="T:Tizen.Security.TEEC.TEFTempMemoryType">
<summary>
- This type denotes TempMemoryReference parameter
+ This type denotes the TempMemoryReference parameter
describing a region of memory which needs to be temporarily registered for the duration of the operation.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Security.TEEC.TEFTempMemoryType.Input">
- <summary>The Parameter is a TempMemoryType and is tagged as input.</summary>
+ <summary>The parameter is a TempMemoryType and is tagged as the input.</summary>
</member>
<member name="F:Tizen.Security.TEEC.TEFTempMemoryType.Output">
- <summary>Same as Input, but the Memory Reference is tagged as output.</summary>
+ <summary>Same as the input, but the Memory Reference is tagged as the output.</summary>
</member>
<member name="F:Tizen.Security.TEEC.TEFTempMemoryType.InOut">
- <summary>A Temporary Memory Reference tagged as both input and output.</summary>
+ <summary>A Temporary Memory Reference tagged as both the input and the output.</summary>
</member>
<member name="T:Tizen.Security.TEEC.TEFRegisteredMemoryType">
<summary>
- This type denotes SharedMemoryReference parameter
+ This type denotes the SharedMemoryReference parameter.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Security.TEEC.TEFRegisteredMemoryType.Whole">
- <summary>The Parameter is a Registered Memory Reference that refers to the entirety of its parent Shared Memory block.</summary>
+ <summary>The parameter is a registered memory reference that refers to the entirety of its parent shared memory block.</summary>
</member>
<member name="F:Tizen.Security.TEEC.TEFRegisteredMemoryType.PartialInput">
- <summary>A Registered Memory Reference structure that refers to a partial region of its parent Shared Memory block and is tagged as input.</summary>
+ <summary>A registered memory reference structure that refers to a partial region of its parent shared mMemory block and is tagged as the input.</summary>
</member>
<member name="F:Tizen.Security.TEEC.TEFRegisteredMemoryType.PartialOutput">
- <summary>A Registered Memory Reference structure that refers to a partial region of its parent Shared Memory block and is tagged as output.</summary>
+ <summary>A registered memory reference structure that refers to a partial region of its parent shared memory block and is tagged as the output.</summary>
</member>
<member name="F:Tizen.Security.TEEC.TEFRegisteredMemoryType.PartialInOut">
- <summary>A Registered Memory Reference structure that refers to a partial region of its parent Shared Memory block and is tagged as both input and output.</summary>
+ <summary>A registered memory reference structure that refers to a partial region of its parent shared memory block and is tagged as both the input and the output.</summary>
</member>
<member name="T:Tizen.Security.TEEC.SharedMemoryFlags">
<summary>
- This type denotes SharedMemory access direction
+ This type denotes the SharedMemory access direction.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="F:Tizen.Security.TEEC.SharedMemoryFlags.Input">
- <summary>A flag indicates Shared Memory can be read.</summary>
+ <summary>A flag indicates the shared memory can be read.</summary>
</member>
<member name="F:Tizen.Security.TEEC.SharedMemoryFlags.Output">
- <summary>A flag indicates Shared Memory can be written.</summary>
+ <summary>A flag indicates the shared memory can be written.</summary>
</member>
<member name="F:Tizen.Security.TEEC.SharedMemoryFlags.InOut">
- <summary>A flag indicates Shared Memory can be read and written.</summary>
+ <summary>A flag indicates the shared memory can be read and written.</summary>
</member>
<member name="T:Tizen.Security.TEEC.SharedMemory">
<summary>
- This type denotes a Shared Memory block which has either been registered
+ This type denotes a shared memory block which has been either registered
with the implementation or allocated by it.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="P:Tizen.Security.TEEC.SharedMemory.Size">
<summary>
- This property represents shared memory size in bytes.
+ This property represents the shared memory size in bytes.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="P:Tizen.Security.TEEC.SharedMemory.Address">
<summary>
- This property represents start address of shared memory block.
+ This property represents the start address of the shared memory block.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="M:Tizen.Security.TEEC.SharedMemory.SetData(System.Byte[],System.Int32)">
<summary>
This function makes a copy and is designed for convenient operations on small buffers.
- For large buffers direct address should be used.
+ For large buffers, the direct address should be used.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="data">Source data buffer to copy data from</param>
- <param name="dstOffs">Starting offset in destination shared memory</param>
+ <param name="data">The source data buffer to copy data from.</param>
+ <param name="dstOffs">The starting offset in the destination shared memory.</param>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
</member>
<member name="M:Tizen.Security.TEEC.SharedMemory.GetData(System.Byte[],System.Int32)">
<summary>
This function makes a copy and is designed for convenient operations on small buffers.
- For large buffers direct address should be used.
+ For large buffers, the direct address should be used.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="data">Destination data buffer to copy data into</param>
- <param name="srcOffs">Starting offset in source shared memory</param>
+ <param name="data">The destination data buffer to copy data into.</param>
+ <param name="srcOffs">The starting offset in the source shared memory.</param>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
</member>
<member name="T:Tizen.Security.TEEC.Parameter">
<summary>
- This type defines the payload of either an open Session operation or an invoke Command operation. It is
- also used for cancellation of operations, which may be desirable even if no payload is passed.
- Parameters are used to exchange data between CA and TA
+ This type defines the payload of either an open session operation or an invoke command operation. It is
+ also used for cancelation of operations, which may be desirable even if no payload is passed.
+ Parameters are used to exchange data between CA and TA.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="T:Tizen.Security.TEEC.BaseParameter`1">
<summary>
- This type defines a template for parameter types.
+ This type defines a template for the parameter types.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="P:Tizen.Security.TEEC.BaseParameter`1.Type">
<summary>
- This property represents access type to this parameter.
+ This property represents the access type to this parameter.
</summary>
<since_tizen> 3 </since_tizen>
</member>
</member>
<member name="M:Tizen.Security.TEEC.TempMemoryReference.#ctor(System.IntPtr,System.UInt32,Tizen.Security.TEEC.TEFTempMemoryType)">
<summary>
- Constructs Prameter object which holds info about temporary memory copied to/from TA
+ Constructs a parameter object which holds information about the temporary memory copied to or from TA.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="buffer">Address of allocated memory buffer</param>
- <param name="size">Size of the buffer</param>
- <param name="type">Kind of access allowed for TA <see cref="T:Tizen.Security.TEEC.TEFTempMemoryType"/></param>
+ <param name="buffer">The address of the allocated memory buffer.</param>
+ <param name="size">The size of the buffer.</param>
+ <param name="type">The kind of access allowed for TA <see cref="T:Tizen.Security.TEEC.TEFTempMemoryType"/>.</param>
</member>
<member name="P:Tizen.Security.TEEC.TempMemoryReference.Buffer">
<summary>
- This property represents memory address of buffer.
+ This property represents the memory address of the buffer.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="P:Tizen.Security.TEEC.TempMemoryReference.Size">
<summary>
- This property represents size of buffer.
+ This property represents the size of the buffer.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="T:Tizen.Security.TEEC.RegisteredMemoryReference">
<summary>
- This type defines a memory reference that uses a pre-registered or pre-allocated Shared Memory block.
+ This type defines a memory reference that uses a pre-registered or pre-allocated shared memory block.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="M:Tizen.Security.TEEC.RegisteredMemoryReference.#ctor(Tizen.Security.TEEC.SharedMemory,System.UInt32,System.UInt32,Tizen.Security.TEEC.TEFRegisteredMemoryType)">
<summary>
- Constructs Prameter object which holds info about registered memory shared with TA
+ Constructs a parameter object which holds information about the registered memory shared with TA.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="parent">Shared memory - registered or allocated</param>
- <param name="size">Size of the buffer part</param>
- <param name="offset">Offset of buffer in shared memory</param>
- <param name="type">Kind of access allowed for TA <see cref="T:Tizen.Security.TEEC.TEFRegisteredMemoryType"/></param>
+ <param name="parent">The shared memory - registered or allocated.</param>
+ <param name="size">The size of the buffer part.</param>
+ <param name="offset">The offset of the buffer in the shared memory.</param>
+ <param name="type">The kind of access allowed for TA <see cref="T:Tizen.Security.TEEC.TEFRegisteredMemoryType"/>.</param>
</member>
<member name="P:Tizen.Security.TEEC.RegisteredMemoryReference.Parent">
<summary>
- This property represents SharedMemory that is referred to.
+ This property represents the shared memory that is referred to.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="P:Tizen.Security.TEEC.RegisteredMemoryReference.Size">
<summary>
- This property represents size (in bytes) of SharedMemory.
+ This property represents the size (in bytes) of the shared memory.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="P:Tizen.Security.TEEC.RegisteredMemoryReference.Offset">
<summary>
- This property represents offset (in bytes) from the begin of SharedMemory.
+ This property represents the offset (in bytes) from the start of the shared memory.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="T:Tizen.Security.TEEC.Value">
<summary>
- This type defines a parameter that is not referencing shared memory, but carries instead small raw data
- passed by value.
+ This type defines a parameter that is not referencing the shared memory, but carries instead small raw data
+ passed by a value.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="M:Tizen.Security.TEEC.Value.#ctor(System.UInt32,System.UInt32,Tizen.Security.TEEC.TEFValueType)">
<summary>
- Constructs Prameter object which holds info about int values copied to/from TA
+ Constructs a parameter object which holds information about integer values copied to or from TA.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="a">User paramter A</param>
- <param name="b">User paramter B</param>
- <param name="type">Kind of access allowed for TA <see cref="T:Tizen.Security.TEEC.TEFValueType"/></param>
+ <param name="a">User paramter A.</param>
+ <param name="b">User paramter B.</param>
+ <param name="type">The kind of access allowed for TA <see cref="T:Tizen.Security.TEEC.TEFValueType"/>.</param>
</member>
<member name="P:Tizen.Security.TEEC.Value.A">
<summary>
- This property represents unsigned integer A.
+ This property represents an unsigned integer A.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="P:Tizen.Security.TEEC.Value.B">
<summary>
- This property represents unsigned integer B.
+ This property represents an unsigned integer B.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="T:Tizen.Security.TEEC.Session">
<summary>
- This type denotes a TEE Session, the logical container linking a Client Application with a particular Trusted Application.
+ This type denotes a TEE Session, the logical container linking a client application with a particular trusted application.
</summary>
<since_tizen> 3 </since_tizen>
</member>
<member name="M:Tizen.Security.TEEC.Session.Close">
<summary>
- This function closes a Session which has been opened with a Trusted Application.
- All Commands within the Session MUST have completed before this function can be called.
+ This function closes a session which has been opened with a trusted application.
+ All commands within the session must be completed before this function can be called.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
</member>
<member name="M:Tizen.Security.TEEC.Session.InvokeCommand(System.UInt32,Tizen.Security.TEEC.Parameter[])">
<summary>
- This function invokes a Command within the specified Session.
- The parameter commandID is an identifier that is used to indicate which of the exposed Trusted
- Application functions should be invoked. The supported command identifier values are defined by the
- Trusted Application's protocol.
- There can be up to four Parameter objects given in the <paramref name="paramlist"/> array
+ This function invokes a command within the specified session.
+ The parameter commandID is an identifier that is used to indicate which of the exposed trusted
+ application functions should be invoked. The supported command identifier values are defined by the
+ trusted application's protocol.
+ There can be up to four parameter objects given in the <paramref name="paramlist"/> array.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="commandID">The command</param>
- <param name="paramlist">The array of parameters</param>
+ <param name="commandID">The command.</param>
+ <param name="paramlist">The array of parameters.</param>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
- <exception cref="T:System.ArgumentException">The argument <paramref name="paramlist"/> is wrong</exception>
+ <exception cref="T:System.ArgumentException">The argument <paramref name="paramlist"/> is wrong.</exception>
</member>
<member name="M:Tizen.Security.TEEC.Session.InvokeCommandAsync(System.UInt32,Tizen.Security.TEEC.Parameter[],System.Threading.CancellationToken)">
<summary>
- Asynchronous version of InvokeCommand
+ The asynchronous version of the InvokeCommand.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="commandID">The command</param>
- <param name="paramlist">The array of parameters</param>
- <param name="token">The token for task manipulation</param>
- <returns>Returns Task executing invoke command in backgroung</returns>
+ <param name="commandID">The command.</param>
+ <param name="paramlist">The array of parameters.</param>
+ <param name="token">The token for task manipulation.</param>
+ <returns>Returns a task executing an invoke command in the background.</returns>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
- <exception cref="T:System.ArgumentException">One of arguments is wrong</exception>
+ <exception cref="T:System.ArgumentException">One of the arguments is wrong.</exception>
</member>
<member name="T:Tizen.Security.TEEC.Context">
<summary>
</member>
<member name="M:Tizen.Security.TEEC.Context.#ctor(System.String)">
<summary>
- This function (constructor) initializes a new TEE Context, forming a connection between this Client Application and the
- TEE identified by the string identifier name (empty or null name denotes default TEE).
+ This function (constructor) initializes a new TEE Context, forming a connection between this client application and the
+ TEE identified by the string identifier name (empty or null name denotes a default TEE).
</summary>
<since_tizen> 3 </since_tizen>
- <param name="name">The TEE name</param>
+ <param name="name">The TEE name.</param>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
</member>
<member name="M:Tizen.Security.TEEC.Context.Dispose">
<summary>
- This function implements IDisposable interface
+ This function implements the IDisposable interface.
</summary>
<since_tizen> 3 </since_tizen>
<privilege>http://tizen.org/privilege/tee.client</privilege>
</member>
<member name="M:Tizen.Security.TEEC.Context.OpenSession(System.Guid,System.UInt32,System.Byte[],Tizen.Security.TEEC.Parameter[])">
<summary>
- This function opens a new Session between the Client Application and the specified Trusted Application.
- The target Trusted Application is identified by a UUID passed in the parameter destination.
- There can be up to four Parameter objects given in the <paramref name="paramlist"/> array
+ This function opens a new session between the client application and the specified trusted application.
+ The target trusted application is identified by an UUID passed in the parameter destination.
+ There can be up to four parameter objects given in the <paramref name="paramlist"/> array.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="destination">The UUID of destination TA</param>
- <param name="loginMethod">The authentication algorithm <see cref="T:Tizen.Security.TEEC.LoginMethod" /></param>
- <param name="connectionData">The data to be verified by given login method</param>
- <param name="paramlist">The parameters to be passed to TA open-session-callback</param>
- <returns>Returns opened session</returns>
+ <param name="destination">The UUID of the destination TA.</param>
+ <param name="loginMethod">The authentication algorithm <see cref="T:Tizen.Security.TEEC.LoginMethod" />.</param>
+ <param name="connectionData">The data to be verified by a given login method.</param>
+ <param name="paramlist">The parameters to be passed to TA open-session-callback.</param>
+ <returns>Returns opened session.</returns>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
- <exception cref="T:System.ArgumentException">One of arguments is wrong</exception>
+ <exception cref="T:System.ArgumentException">One of the arguments is wrong.</exception>
</member>
<member name="M:Tizen.Security.TEEC.Context.OpenSession(System.Guid)">
<summary>
- @see OpenSession(Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token)
+ @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token).
</summary>
<since_tizen> 3 </since_tizen>
- <param name="destination">The UUID of destination TA</param>
- <returns>Returns opened session</returns>
+ <param name="destination">The UUID of the destination TA.</param>
+ <returns>Returns opened session.</returns>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
</member>
<member name="M:Tizen.Security.TEEC.Context.OpenSessionAsync(System.Guid,System.UInt32,System.Byte[],Tizen.Security.TEEC.Parameter[],System.Threading.CancellationToken)">
<summary>
- Asynchronous version of OpenSession
- @see OpenSession(Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token)
+ The asynchronous version of the OpenSession.
+ @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token).
</summary>
<since_tizen> 3 </since_tizen>
- <param name="destination">The UUID of destination TA</param>
- <param name="loginMethod">The authentication algorithm <see cref="T:Tizen.Security.TEEC.LoginMethod" /></param>
- <param name="connectionData">The data to be verified by given login method</param>
- <param name="paramlist">The parameters to be passed to TA open-session-callback</param>
- <param name="token">The token for task manipulation</param>
- <returns>Returns Task executing session open in backgroung</returns>
+ <param name="destination">The UUID of the destination TA.</param>
+ <param name="loginMethod">The authentication algorithm <see cref="T:Tizen.Security.TEEC.LoginMethod" />.</param>
+ <param name="connectionData">The data to be verified by a given login method.</param>
+ <param name="paramlist">The parameters to be passed to the TA open-session-callback.</param>
+ <param name="token">The token for the task manipulation.</param>
+ <returns>Returns a Task executing the session open in the background.</returns>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
- <exception cref="T:System.ArgumentException">One of arguments is wrong</exception>
+ <exception cref="T:System.ArgumentException">One of the arguments is wrong.</exception>
</member>
<member name="M:Tizen.Security.TEEC.Context.OpenSessionAsync(System.Guid,System.Threading.CancellationToken)">
<summary>
- Asynchronous version of OpenSession
- @see OpenSession(Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token)
+ The asynchronous version of the OpenSession.
+ @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token).
</summary>
<since_tizen> 3 </since_tizen>
- <param name="destination">The UUID of destination TA</param>
- <param name="token">The token for task manipulation</param>
- <returns>Returns Task executing session open in backgroung</returns>
+ <param name="destination">The UUID of the destination TA.</param>
+ <param name="token">The token for a task manipulation.</param>
+ <returns>Returns a task executing session open in the background.</returns>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
</member>
<member name="M:Tizen.Security.TEEC.Context.RegisterSharedMemory(System.IntPtr,System.UInt32,Tizen.Security.TEEC.SharedMemoryFlags)">
<summary>
- This function registers a block of existing Client Application memory as a block of Shared Memory within
- the scope of the specified Context, in accordance with the parameters.
- The input <paramref name="memaddr"/> MUST point to the shared memory region to register
+ This function registers a block of the existing client application memory as a block of shared memory within
+ the scope of the specified context, in accordance with the parameters.
+ The input <paramref name="memaddr"/> must point to the shared memory region to register.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="memaddr">The address of shared memory</param>
- <param name="size">The size of shared memory</param>
- <param name="flags">The flags describing access modes (Input and/or Output)</param>
- <returns>Returns SharedMemory handler</returns>
+ <param name="memaddr">The address of the shared memory.</param>
+ <param name="size">The size of the shared memory.</param>
+ <param name="flags">The flags describing the access modes (Input and/or Output).</param>
+ <returns>Returns the SharedMemory handler.</returns>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
- <exception cref="T:System.ArgumentException">The argument <paramref name="memaddr"/> is wrong</exception>
+ <exception cref="T:System.ArgumentException">The argument <paramref name="memaddr"/> is wrong.</exception>
</member>
<member name="M:Tizen.Security.TEEC.Context.AllocateSharedMemory(System.UInt32,Tizen.Security.TEEC.SharedMemoryFlags)">
<summary>
- This function allocates a new block of memory as a block of Shared Memory within the scope of the
- specified Context, in accordance with the parameters.
+ This function allocates a new block of memory as a block of shared memory within the scope of the
+ specified context, in accordance with the parameters.
</summary>
<since_tizen> 3 </since_tizen>
- <param name="size">The size of shared memory</param>
- <param name="flags">The flags describing access modes (Input and/or Output)</param>
- <returns>Returns SharedMemory handler</returns>
+ <param name="size">The size of shared memory.</param>
+ <param name="flags">The flags describing access modes (Input and/or Output).</param>
+ <returns>Returns the Shared Memory handler.</returns>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
</member>
<member name="M:Tizen.Security.TEEC.Context.ReleaseSharedMemory(Tizen.Security.TEEC.SharedMemory)">
<summary>
- This function deregisters or deallocates a previously initialized block of Shared Memory.
+ This function deregisters or deallocates a previously initialized block of the shared memory.
</summary>
<remarks>
- For a memory buffer allocated using AllocateSharedMemory the Implementation MUST free the
- underlying memory and the Client Application MUST NOT access this region after this function has been
- called. In this case the Implementation MUST clear the buffer and size fields of the sharedMem
+ For a memory buffer allocated using AllocateSharedMemory, the implementation must free the
+ underlying memory and the client application must not access this region after this function has been
+ called. In this case, the implementation must clear the buffer and size fields of the shared memory
structure before returning.
- For memory registered using RegisterSharedMemory the implementation MUST deregister the
- underlying memory from the TEE, but the memory region will stay available to the Client Application for
+ For memory registered using RegisterSharedMemory, the implementation must deregister the
+ underlying memory from the TEE, but the memory region will stay available to the client application for
other purposes as the memory is owned by it.
</remarks>
<since_tizen> 3 </since_tizen>
- <param name="shm">The shared memory object returned by RegisterSharedMemory or AllocateSharedMemory</param>
+ <param name="shm">The shared memory object returned by RegisterSharedMemory or AllocateSharedMemory.</param>
<privilege>http://tizen.org/privilege/tee.client</privilege>
<privlevel>partner</privlevel>
<feature>http://tizen.org/feature/security.tee</feature>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
<exception cref="T:System.NotSupportedException">The required feature is not supported.</exception>
<exception cref="T:System.InvalidOperationException">The operation is invalid.</exception>
- <exception cref="T:System.ArgumentException">The argument is wrong</exception>
+ <exception cref="T:System.ArgumentException">The argument is wrong.</exception>
</member>
</members>
</doc>
<members>
<member name="T:Tizen.System.SystemSettings">
<summary>
- The System Settings API provides APIs for sharing configuration over a system
+ The System Settings API provides APIs for sharing the configuration over a system.
</summary>
<remarks>
- System Settings API provides functions for getting the system configuration related to user preferences.
- The main features of the System Settings API include accessing system-wide configurations, such as ringtones, wallpapers, and etc
+ The System Settings API provides functions for getting the system configuration related to user preferences.
+ The main features of the System Settings API include accessing system-wide configurations, such as ringtones, wallpapers, and so on.
</remarks>
</member>
<member name="P:Tizen.System.SystemSettings.IncomingCallRingtone">
<summary>
- The file path of the current ringtone
+ The file path of the current ringtone.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.WallpaperHomeScreen">
<summary>
- The file path of the current home screen wallpaper
+ The file path of the current home-screen wallpaper.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.WallpaperLockScreen">
<summary>
- The file path of the current lock screen wallpaper
+ The file path of the current lock-screen wallpaper.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.FontSize">
<summary>
- The current system font size
+ The current system font size.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.FontType">
<summary>
- The current system font type
+ The current system font type.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.MotionActivationEnabled">
<summary>
- Indicates whether the motion service is activated
+ Indicates whether the motion service is activated.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.EmailAlertRingtone">
<summary>
- The file path of the current email alert ringtone
+ The file path of the current email alert ringtone.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.UsbDebuggingEnabled">
<summary>
- Indicates whether the USB debugging is enabled
+ Indicates whether the USB debugging is enabled.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.Data3GNetworkEnabled">
<summary>
- Indicates whether the 3G data network is enabled
+ Indicates whether the 3G data network is enabled.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.LockscreenApp">
<summary>
- Indicates lockscreen app pkg name
+ Indicates the lock-screen application package name.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.DefaultFontType">
<summary>
- The current system default font type (only support Get)
+ The current system default font type (only supports Get).
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.LocaleCountry">
<summary>
Indicates the current country setting in the <LANGUAGE>_<REGION> syntax.
The country setting is in the ISO 639-2 format,
- and the region setting is in the ISO 3166-1 alpha-2 format
+ and the region setting is in the ISO 3166-1 alpha-2 format.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.LocaleLanguage">
<summary>
Indicates the current language setting in the <LANGUAGE>_<REGION> syntax.
- The language setting is in the ISO 639-2 format
+ The language setting is in the ISO 639-2 format,
and the region setting is in the ISO 3166-1 alpha-2 format.
</summary>
</member>
</member>
<member name="P:Tizen.System.SystemSettings.LocaleTimeZone">
<summary>
- Indicates the current time zone. Eg. "Pacific/Tahiti"
+ Indicates the current time zone, for example, Pacific/Tahiti.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.Time">
<summary>
- Once System changes time, this event occurs to notify time change.
+ Once the system changes time, this event occurs to notify the time change.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.SoundLockEnabled">
<summary>
- Indicates whether the screen lock sound is enabled on the device. ex) LCD on/off sound
+ Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.SoundSilentModeEnabled">
</member>
<member name="P:Tizen.System.SystemSettings.DisplayScreenRotationAutoEnabled">
<summary>
- Indicates whether rotation control is automatic.
+ Indicates whether the rotation control is automatic.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.DeviceName">
<summary>
- Indicates device name.
+ Indicates the device name.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.MotionEnabled">
<summary>
- Indicates whether the device user has enabled motion feature.
+ Indicates whether the device user has enabled the motion feature.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.NetworkWifiNotificationEnabled">
<summary>
- Indicates whether Wi-Fi-related notifications are enabled on the device.
+ Indicates whether Wi-Fi related notifications are enabled on the device.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.NetworkFlightModeEnabled">
</member>
<member name="P:Tizen.System.SystemSettings.LockState">
<summary>
- Indicates the current lock state
+ Indicates the current lock state.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.AdsId">
<summary>
- The current system ADS ID
+ The current system ADS ID.
</summary>
</member>
<member name="P:Tizen.System.SystemSettings.UltraDataSave">
Indicates the time period for notification repetitions.
</summary>
</member>
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.IncomingCallRingtoneChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.WallpaperHomeScreenChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.WallpaperLockScreenChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.FontSizeChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.FontTypeChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.MotionActivationSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.EmailAlertRingtoneChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.UsbDebuggingSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.Data3GNetworkSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.LockscreenAppChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.LocaleCountryChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.LocaleLanguageChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.LocaleTimeFormat24HourSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.LocaleTimeZoneChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.TimeChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.SoundLockSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.SoundSilentModeSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.SoundTouchSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.DisplayScreenRotationAutoSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.DeviceNameChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.MotionSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.NetworkWifiNotificationSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.NetworkFlightModeSettingChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.ScreenBacklightTimeChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.SoundNotificationChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.SoundNotificationRepetitionPeriodChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.LockStateChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.AdsIdChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.UltraDataSaveChanged" -->
- <!-- Badly formed XML comment ignored for member "E:Tizen.System.SystemSettings.UltraDataSavePackageListChanged" -->
+ <member name="E:Tizen.System.SystemSettings.IncomingCallRingtoneChanged">
+ <summary>
+ The IncomingCallRingtoneChanged event is triggered when the file path of the incoming ringtone is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The IncomingCallRingtoneChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.WallpaperHomeScreenChanged">
+ <summary>
+ THe WallpaperHomeScreenChanged event is triggered when the file path of the current home screen wallpaper is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The WallpaperHomeScreenChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.WallpaperLockScreenChanged">
+ <summary>
+ The WallpaperLockScreenChanged event is triggered when the file path of the current lock screen wallpaper is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The WallpaperLockScreenChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.FontSizeChanged">
+ <summary>
+ The FontSizeChanged event is triggered when the current system font size is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The FontSizeChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.FontTypeChanged">
+ <summary>
+ The FontTypeChanged event is triggered when the current system font type is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The FontTypeChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.MotionActivationSettingChanged">
+ <summary>
+ The MotionActivationChanged event is triggered when the motion service status is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The MotionActivationChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.EmailAlertRingtoneChanged">
+ <summary>
+ The EmailAlertRingtoneChanged event is triggered when the file path of the current email alert ringtone is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The EmailAlertRingtoneChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.UsbDebuggingSettingChanged">
+ <summary>
+ The UsbDebuggingSettingChangedEventArgs event is triggered when the USB debugging status is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The UsbDebuggingSettingChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.Data3GNetworkSettingChanged">
+ <summary>
+ The Data3GNetworkSettingChanged event is triggered when the 3G data network status is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The Data3GNetworkSettingChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.LockscreenAppChanged">
+ <summary>
+ The LockscreenAppChanged event is triggered when the lockscreen application package name is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The LockscreenAppChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.LocaleCountryChanged">
+ <summary>
+ The LocaleCountryChanged event is triggered when the current country setting in the <LANGUAGE>_<REGION> syntax, is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The LocaleCountryChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.LocaleLanguageChanged">
+ <summary>
+ The LocaleLanguageChanged event is triggered when the current language setting in the <LANGUAGE>_<REGION> syntax, is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The LocaleLanguageChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.LocaleTimeFormat24HourSettingChanged">
+ <summary>
+ The LocaleTimeFormat24HourChanged event is triggered when the time format is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The LocaleTimeFormat24HourChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.LocaleTimeZoneChanged">
+ <summary>
+ The LocaleTimeZoneChanged event is triggered when the current time zone is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The LocaleTimeZoneChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.TimeChanged">
+ <summary>
+ The TimeChanged event is triggered when the system time is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The TimeChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.SoundLockSettingChanged">
+ <summary>
+ The SoundLockChanged event is triggered when the screen lock sound enabled status is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The SoundLockChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.SoundSilentModeSettingChanged">
+ <summary>
+ The SoundSilentModeChanged event is triggered when the silent mode status is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The SoundSilentModeChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.SoundTouchSettingChanged">
+ <summary>
+ THe SoundTouchChanged event is triggered when the screen touch sound enabled status is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The SoundTouchChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.DisplayScreenRotationAutoSettingChanged">
+ <summary>
+ The DisplayScreenRotationAutoChanged event is triggered when the automatic rotation control status is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The DisplayScreenRotationAutoChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.DeviceNameChanged">
+ <summary>
+ The DeviceNameChanged event is triggered when the device name is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The DeviceNameChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.MotionSettingChanged">
+ <summary>
+ The MotionSettingChanged event is triggered when the motion feature enabled status is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The MotionSettingChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.NetworkWifiNotificationSettingChanged">
+ <summary>
+ The NetworkWifiNotificationChanged event is triggered when the WiFi-related notifications enabled status is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The NetworkWifiNotificationChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.NetworkFlightModeSettingChanged">
+ <summary>
+ The NetworkFlightModeChanged event is triggered when the flight mode status is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The NetworkFlightModeChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.ScreenBacklightTimeChanged">
+ <summary>
+ THe ScreenBacklightTimeChanged event is triggered when the backlight time is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The ScreenBacklightTimeChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.SoundNotificationChanged">
+ <summary>
+ The SoundNotificationChanged event is triggered when the file path of the current notification tone set by the user is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The SoundNotificationChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.SoundNotificationRepetitionPeriodChanged">
+ <summary>
+ The SoundNotificationRepetitionPeriodChanged event is triggered when the time period for notification repetitions is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The SoundNotificationRepetitionPeriodChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.LockStateChanged">
+ <summary>
+ The LockStateChanged event is triggered when the current lock state is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The LockStateChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.AdsIdChanged">
+ <summary>
+ The AdsIdChanged event is triggered when the current ADS ID state is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The AdsIdChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.UltraDataSaveChanged">
+ <summary>
+ The UltraDataSaveChanged event is triggered when the current Ultra Data Save state is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The UltraDataSaveChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
+ <member name="E:Tizen.System.SystemSettings.UltraDataSavePackageListChanged">
+ <summary>
+ The UltraDataSavePackageListChanged event is triggered when the current ADS ID state is changed.
+ </summary>
+ <param name="sender"></param>
+ <param name="e">The UltraDataSavePackageListChangedEventArgs object that contains the key and the changed value.</param>
+ </member>
<member name="T:Tizen.System.SystemSettingsKeys">
<summary>
- Enumeration for all available system settings
+ Enumeration for all the available system settings.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.IncomingCallRingtone">
<summary>
- (string) The file path of the current ringtone
+ GET (string) The file path of the current ringtone.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.WallpaperHomeScreen">
<summary>
- (string) The file path of the current home screen wallpaper
+ GET (string) The file path of the current home-screen wallpaper.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.WallpaperLockScreen">
<summary>
- (string) The file path of the current lock screen wallpaper
+ GET (string) The file path of the current lock-screen wallpaper.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.FontSize">
<summary>
- (int) The current system font size
+ GET (int) The current system font size.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.FontType">
<summary>
- (string) The current system font type
+ GET (string) The current system font type.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.MotionActivationEnabled">
<summary>
- (bool) Indicates whether the motion service is activated
+ GET (bool) Indicates whether the motion service is activated.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.EmailAlertRingtone">
<summary>
- (string) The file path of the current email alert ringtone
+ GET (string) The file path of the current email alert ringtone.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.UsbDebuggingEnabled">
<summary>
- (bool) Indicates whether the USB debugging is enabled
+ GET (bool) Indicates whether the USB debugging is enabled.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.Data3GNetworkEnabled">
<summary>
- (bool) Indicates whether the 3G data network is enabled
+ GET (bool) Indicates whether the 3G-data network is enabled.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.LockscreenApp">
<summary>
- (string) Indicates lockscreen app pkg name
+ GET (string) Indicates the lock-screen application package name.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.DefaultFontType">
<summary>
- (string) The current system default font type (only support Get)
+ GET (string) The current system default font type (only supports Get).
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.LocaleCountry">
<summary>
- (string) Indicates the current country setting in the <LANGUAGE>_<REGION> syntax.
+ GET (string) Indicates the current country setting in the <LANGUAGE>_<REGION> syntax.
The country setting is in the ISO 639-2 format,
- and the region setting is in the ISO 3166-1 alpha-2 format
+ and the region setting is in the ISO 3166-1 alpha-2 format.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.LocaleLanguage">
<summary>
- (string) Indicates the current language setting in the <LANGUAGE>_<REGION> syntax.
- The language setting is in the ISO 639-2 format
+ GET (string) Indicates the current language setting in the <LANGUAGE>_<REGION> syntax.
+ The language setting is in the ISO 639-2 format,
and the region setting is in the ISO 3166-1 alpha-2 format.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.LocaleTimeFormat24HourEnabled">
<summary>
- (bool) Indicates whether the 24-hour clock is used.
+ GET (bool) Indicates whether the 24-hour clock is used.
If the value is false, the 12-hour clock is used.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.LocaleTimeZone">
<summary>
- (string) Indicates the current time zone. Eg. Pacific/Tahiti
+ GET (string) Indicates the current time zone, for example, Pacific/Tahiti.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.Time">
<summary>
- (int) Once System changes time, this event occurs to notify time change.
+ GET (int) Once system changes the time, this event occurs to notify the time change.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.SoundLockEnabled">
<summary>
- GET (bool) Indicates whether the screen lock sound is enabled on the device. ex) LCD on/off sound
+ GET (bool) Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.SoundSilentModeEnabled">
</member>
<member name="F:Tizen.System.SystemSettingsKeys.DisplayScreenRotationAutoEnabled">
<summary>
- GET (bool) Indicates whether rotation control is automatic.
+ GET (bool) Indicates whether the rotation control is automatic.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.DeviceName">
<summary>
- GET (string) Indicates device name.
+ GET (string) Indicates the device name.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.MotionEnabled">
<summary>
- GET (bool) Indicates whether the device user has enabled motion feature.
+ GET (bool) Indicates whether the device user has the enabled motion feature.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.NetworkWifiNotificationEnabled">
<summary>
- GET (bool) Indicates whether Wi-Fi-related notifications are enabled on the device.
+ GET (bool) Indicates whether WiFi-related notifications are enabled on the device.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.NetworkFlightModeEnabled">
</member>
<member name="F:Tizen.System.SystemSettingsKeys.ScreenBacklightTime">
<summary>
- (int) Indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600.
+ GET (int) Indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.SoundNotification">
<summary>
- (string) Indicates the file path of the current notification tone set by the user.
+ GET (string) Indicates the file path of the current notification tone set by the user.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.SoundNotificationRepetitionPeriod">
<summary>
- (int) Indicates the time period for notification repetitions.
+ GET (int) Indicates the time period for notification repetitions.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.LockState">
<summary>
- (int) Indicates the current lock state
+ GET (int) Indicates the current lock state.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.AdsId">
<summary>
- (string) Indicates Ads ID for each device
+ GET (string) Indicates the ADS ID for each device.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.UltraDataSave">
<summary>
- (int) Indicates Ultra Data Save status, one of #SystemSettingsUdsState values
+ GET (int) Indicates the Ultra Data Save status, one of the #SystemSettingsUdsState values.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsKeys.UltraDataSavePackageList">
<summary>
- (string) Indicates Ultra Data Save Package List (Since 4.0), the list is a string containing whitelisted package names separated with semicolons (;)
+ GET (string) Indicates the Ultra Data Save Package List. Since 4.0, the list is a string containing whitelisted package names separated with semicolons (;).
</summary>
</member>
<member name="T:Tizen.System.SystemSettingsIdleLockState">
<summary>
- Enumeration for Idle Lock State.
+ Enumeration for the Idle Lock State.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsIdleLockState.Unlock">
<summary>
- Device is unlocked
+ The device is unlocked.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsIdleLockState.Lock">
<summary>
- Device is locked
+ The device is locked.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsIdleLockState.LaunchingLock">
<summary>
- Device is being locked
+ The device is being locked.
</summary>
</member>
<member name="T:Tizen.System.SystemSettingsFontSize">
<summary>
- Enumeration for font size.
+ Enumeration for the font size.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsFontSize.Small">
<summary>
- A small size
+ A small size.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsFontSize.Normal">
<summary>
- A normal size
+ A normal size.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsFontSize.Large">
<summary>
- A large size
+ A large size.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsFontSize.Huge">
<summary>
- A huge size
+ A huge size.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsFontSize.Giant">
<summary>
- A giant size
+ A giant size.
</summary>
</member>
<member name="T:Tizen.System.SystemSettingsUdsState">
<summary>
- Enumeration for ultra data save
+ Enumeration for the ultra data save.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsUdsState.UdsOff">
<summary>
- UDS Off
+ UDS Off.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsUdsState.UdsOn">
<summary>
- UDS On
+ UDS On.
</summary>
</member>
<member name="F:Tizen.System.SystemSettingsUdsState.UdsOnWhitelisted">
<summary>
- UDS On and the app is whitelisted
+ UDS On and the application is whitelisted.
</summary>
</member>
<member name="T:Tizen.System.IncomingCallRingtoneChangedEventArgs">
<summary>
- EventArgs type for the event IncomingCallRingtoneChanged
+ EventArgs type for the IncomingCallRingtoneChanged event.
</summary>
</member>
<member name="P:Tizen.System.IncomingCallRingtoneChangedEventArgs.Value">
<summary>
- The file path of the current ringtone
+ The file path of the current ringtone.
</summary>
</member>
<member name="T:Tizen.System.WallpaperHomeScreenChangedEventArgs">
<summary>
- EventArgs type for the event WallpaperHomeScreenChanged
+ EventArgs type for the WallpaperHomeScreenChanged event.
</summary>
</member>
<member name="P:Tizen.System.WallpaperHomeScreenChangedEventArgs.Value">
<summary>
- The file path of the current home screen wallpaper
+ The file path of the current home screen wallpaper.
</summary>
</member>
<member name="T:Tizen.System.WallpaperLockScreenChangedEventArgs">
<summary>
- EventArgs type for the event WallpaperLockScreenChanged
+ EventArgs type for the WallpaperLockScreenChanged event.
</summary>
</member>
<member name="P:Tizen.System.WallpaperLockScreenChangedEventArgs.Value">
<summary>
- The file path of the current lock screen wallpaper
+ The file path of the current lock screen wallpaper.
</summary>
</member>
<member name="T:Tizen.System.FontSizeChangedEventArgs">
<summary>
- EventArgs type for the event FontSizeChanged
+ EventArgs type for the FontSizeChanged event.
</summary>
</member>
<member name="P:Tizen.System.FontSizeChangedEventArgs.Value">
<summary>
- The current system font size
+ The current system font size.
</summary>
</member>
<member name="T:Tizen.System.FontTypeChangedEventArgs">
<summary>
- EventArgs type for the event FontTypeChanged
+ EventArgs type for the FontTypeChanged event.
</summary>
</member>
<member name="P:Tizen.System.FontTypeChangedEventArgs.Value">
<summary>
- The current system font type
+ The current system font type.
</summary>
</member>
<member name="T:Tizen.System.MotionActivationSettingChangedEventArgs">
<summary>
- EventArgs type for the event MotionActivationChanged
+ EventArgs type for the MotionActivationChanged event.
</summary>
</member>
<member name="P:Tizen.System.MotionActivationSettingChangedEventArgs.Value">
<summary>
- Indicates whether the motion service is activated
+ Indicates whether the motion service is activated.
</summary>
</member>
<member name="T:Tizen.System.EmailAlertRingtoneChangedEventArgs">
<summary>
- EventArgs type for the event EmailAlertRingtoneChanged
+ EventArgs type for the EmailAlertRingtoneChanged event.
</summary>
</member>
<member name="P:Tizen.System.EmailAlertRingtoneChangedEventArgs.Value">
<summary>
- The file path of the current email alert ringtone
+ The file path of the current email alert ringtone.
</summary>
</member>
<member name="T:Tizen.System.UsbDebuggingSettingChangedEventArgs">
<summary>
- EventArgs type for the event UsbDebuggingSettingChanged
+ EventArgs type for the UsbDebuggingSettingChanged event.
</summary>
</member>
<member name="P:Tizen.System.UsbDebuggingSettingChangedEventArgs.Value">
<summary>
- Indicates whether the USB debugging is enabled
+ Indicates whether the USB debugging is enabled.
</summary>
</member>
<member name="T:Tizen.System.Data3GNetworkSettingChangedEventArgs">
<summary>
- EventArgs type for the event Data3GNetworkSettingChanged
+ EventArgs type for the Data3GNetworkSettingChanged event.
</summary>
</member>
<member name="P:Tizen.System.Data3GNetworkSettingChangedEventArgs.Value">
<summary>
- Indicates whether the 3G data network is enabled
+ Indicates whether the 3G data network is enabled.
</summary>
</member>
<member name="T:Tizen.System.LockscreenAppChangedEventArgs">
<summary>
- EventArgs type for the event LockscreenAppChanged
+ EventArgs type for the LockscreenAppChanged event.
</summary>
</member>
<member name="P:Tizen.System.LockscreenAppChangedEventArgs.Value">
<summary>
- Indicates lockscreen app pkg name
+ Indicates the lock screen application package name.
</summary>
</member>
<member name="T:Tizen.System.LocaleCountryChangedEventArgs">
<summary>
- EventArgs type for the event LocaleCountryChanged
+ EventArgs type for the LocaleCountryChanged event.
</summary>
</member>
<member name="P:Tizen.System.LocaleCountryChangedEventArgs.Value">
<summary>
Indicates the current country setting in the <LANGUAGE>_<REGION> syntax.
- The country setting is in the ISO 639-2 format, and the region setting is in the ISO 3166-1 alpha-2 format
+ The country setting is in the ISO 639-2 format, and the region setting is in the ISO 3166-1 alpha-2 format.
</summary>
</member>
<member name="T:Tizen.System.LocaleLanguageChangedEventArgs">
<summary>
- EventArgs type for the event LocaleLanguageChanged
+ EventArgs type for the LocaleLanguageChanged event.
</summary>
</member>
<member name="P:Tizen.System.LocaleLanguageChangedEventArgs.Value">
<summary>
Indicates the current language setting in the <LANGUAGE>_<REGION> syntax.
- The language setting is in the ISO 639-2 format and the region setting is in the ISO 3166-1 alpha-2 format
+ The language setting is in the ISO 639-2 format and the region setting is in the ISO 3166-1 alpha-2 format.
</summary>
</member>
<member name="T:Tizen.System.LocaleTimeFormat24HourSettingChangedEventArgs">
<summary>
- EventArgs type for the event LocaleTimeFormat24HourChanged
+ EventArgs type for the LocaleTimeFormat24HourChanged event.
</summary>
</member>
<member name="P:Tizen.System.LocaleTimeFormat24HourSettingChangedEventArgs.Value">
</member>
<member name="T:Tizen.System.LocaleTimeZoneChangedEventArgs">
<summary>
- EventArgs type for the event LocaleTimeZoneChanged
+ EventArgs type for the LocaleTimeZoneChanged event.
</summary>
</member>
<member name="P:Tizen.System.LocaleTimeZoneChangedEventArgs.Value">
<summary>
- Indicates the current time zone
+ Indicates the current time zone.
</summary>
</member>
<member name="T:Tizen.System.TimeChangedEventArgs">
<summary>
- EventArgs type for the event TimeChanged
+ EventArgs type for the TimeChanged event.
</summary>
</member>
<member name="P:Tizen.System.TimeChangedEventArgs.Value">
<summary>
- Indicates the current time
+ Indicates the current time.
</summary>
</member>
<member name="T:Tizen.System.SoundLockSettingChangedEventArgs">
<summary>
- EventArgs type for the event SoundLockChanged
+ EventArgs type for the SoundLockChanged event.
</summary>
</member>
<member name="P:Tizen.System.SoundLockSettingChangedEventArgs.Value">
<summary>
- Indicates whether the screen lock sound is enabled on the device. ex) LCD on/off sound
+ Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound.
</summary>
</member>
<member name="T:Tizen.System.SoundSilentModeSettingChangedEventArgs">
<summary>
- EventArgs type for the event SoundSilentModeChanged
+ EventArgs type for the SoundSilentModeChanged event.
</summary>
</member>
<member name="P:Tizen.System.SoundSilentModeSettingChangedEventArgs.Value">
</member>
<member name="T:Tizen.System.SoundTouchSettingChangedEventArgs">
<summary>
- EventArgs type for the event SoundTouchChanged
+ EventArgs type for the SoundTouchChanged event.
</summary>
</member>
<member name="P:Tizen.System.SoundTouchSettingChangedEventArgs.Value">
</member>
<member name="T:Tizen.System.DisplayScreenRotationAutoSettingChangedEventArgs">
<summary>
- EventArgs type for the event DisplayScreenRotationAutoChanged
+ EventArgs type for the DisplayScreenRotationAutoChanged event.
</summary>
</member>
<member name="P:Tizen.System.DisplayScreenRotationAutoSettingChangedEventArgs.Value">
<summary>
- Indicates whether rotation control is automatic
+ Indicates whether the rotation control is automatic.
</summary>
</member>
<member name="T:Tizen.System.DeviceNameChangedEventArgs">
<summary>
- EventArgs type for the event DeviceNameChanged
+ EventArgs type for the DeviceNameChanged event.
</summary>
</member>
<member name="P:Tizen.System.DeviceNameChangedEventArgs.Value">
<summary>
- Indicates device name
+ Indicates the device name.
</summary>
</member>
<member name="T:Tizen.System.MotionSettingChangedEventArgs">
<summary>
- EventArgs type for the event MotionSettingChanged
+ EventArgs type for the MotionSettingChanged event.
</summary>
</member>
<member name="P:Tizen.System.MotionSettingChangedEventArgs.Value">
<summary>
- Indicates whether the device user has enabled motion feature
+ Indicates whether the device user has enabled the motion feature.
</summary>
</member>
<member name="T:Tizen.System.NetworkWifiNotificationSettingChangedEventArgs">
<summary>
- EventArgs type for the event NetworkWifiNotificationChanged
+ EventArgs type for the NetworkWifiNotificationChanged event.
</summary>
</member>
<member name="P:Tizen.System.NetworkWifiNotificationSettingChangedEventArgs.Value">
<summary>
- Indicates whether Wi-Fi-related notifications are enabled on the device
+ Indicates whether Wi-Fi-related notifications are enabled on the device.
</summary>
</member>
<member name="T:Tizen.System.NetworkFlightModeSettingChangedEventArgs">
<summary>
- EventArgs type for the event NetworkFlightModeChanged
+ EventArgs type for the NetworkFlightModeChanged event.
</summary>
</member>
<member name="P:Tizen.System.NetworkFlightModeSettingChangedEventArgs.Value">
<summary>
- Indicates whether the device is in the flight mode
+ Indicates whether the device is in the flight mode.
</summary>
</member>
<member name="T:Tizen.System.ScreenBacklightTimeChangedEventArgs">
<summary>
- EventArgs type for the event ScreenBacklightTimeChanged
+ EventArgs type for the ScreenBacklightTimeChanged event.
</summary>
</member>
<member name="P:Tizen.System.ScreenBacklightTimeChangedEventArgs.Value">
<summary>
- Indicates the backlight time (in seconds)
+ Indicates the backlight time (in seconds).
</summary>
</member>
<member name="T:Tizen.System.SoundNotificationChangedEventArgs">
<summary>
- EventArgs type for the event SoundNotificationChanged
+ EventArgs type for the SoundNotificationChanged event.
</summary>
</member>
<member name="P:Tizen.System.SoundNotificationChangedEventArgs.Value">
<summary>
- Indicates the file path of the current notification tone set by the user
+ Indicates the file path of the current notification tone set by the user.
</summary>
</member>
<member name="T:Tizen.System.SoundNotificationRepetitionPeriodChangedEventArgs">
<summary>
- EventArgs type for the event SoundNotificationRepetitionPeriodChanged
+ EventArgs type for the SoundNotificationRepetitionPeriodChanged event.
</summary>
</member>
<member name="P:Tizen.System.SoundNotificationRepetitionPeriodChangedEventArgs.Value">
<summary>
- Indicates the time period for notification repetitions
+ Indicates the time period for notification repetitions.
</summary>
</member>
<member name="T:Tizen.System.LockStateChangedEventArgs">
<summary>
- EventArgs type for the event LockStateChanged
+ EventArgs type for the LockStateChanged event.
</summary>
</member>
<member name="P:Tizen.System.LockStateChangedEventArgs.Value">
<summary>
- Indicates the current lock state
+ Indicates the current lock state.
</summary>
</member>
<member name="T:Tizen.System.AdsIdChangedEventArgs">
<summary>
- EventArgs type for the event AdsIdChanged
+ EventArgs type for the AdsIdChanged event.
</summary>
</member>
<member name="P:Tizen.System.AdsIdChangedEventArgs.Value">
<summary>
- Indicates the current lock state
+ Indicates the current lock state.
</summary>
</member>
<member name="T:Tizen.System.UltraDataSaveChangedEventArgs">
<summary>
- EventArgs type for the event UltraDataSaveChanged
+ EventArgs type for the UltraDataSaveChanged event.
</summary>
</member>
<member name="P:Tizen.System.UltraDataSaveChangedEventArgs.Value">
<summary>
- Indicates the current lock state
+ Indicates the current lock state.
</summary>
</member>
<member name="T:Tizen.System.UltraDataSavePackageListChangedEventArgs">
<summary>
- EventArgs type for the event UltraDataSavePackageListChanged
+ EventArgs type for the UltraDataSavePackageListChanged event.
</summary>
</member>
<member name="P:Tizen.System.UltraDataSavePackageListChangedEventArgs.Value">
<summary>
- Indicates the current lock state
+ Indicates the current lock state.
</summary>
</member>
</members>
Name: csapi-tizenfx
Summary: Assemblies of Tizen .NET
-Version: 4.0.0.107
+Version: 4.0.0.111
Release: 1
Group: Development/Libraries
License: Apache-2.0
Tizen.Messaging.Push.dll #mobile #mobile-emul #tv #ivi
Tizen.Multimedia.AudioIO.dll #common #mobile #mobile-emul #tv #ivi
Tizen.Multimedia.Camera.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.MediaCodec.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.MediaPlayer.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.Metadata.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.Radio.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.Recorder.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.Remoting.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.StreamRecorder.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.Util.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Multimedia.Vision.dll #common #mobile #mobile-emul #tv #ivi
+Tizen.Multimedia.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Multimedia.MediaCodec.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Multimedia.MediaPlayer.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Multimedia.Metadata.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Multimedia.Radio.dll #common #mobile #mobile-emul #ivi #wearable
+Tizen.Multimedia.Recorder.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Multimedia.Remoting.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Multimedia.StreamRecorder.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Multimedia.Util.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Multimedia.Vision.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.Network.Bluetooth.dll #common #mobile #tv #ivi #wearable
Tizen.Network.Connection.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.Network.IoTConnectivity.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.Tracer.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.Uix.InputMethod.dll #common #mobile #mobile-emul #ivi
Tizen.Uix.InputMethodManager.dll #common #mobile #mobile-emul #tv #ivi
-Tizen.Uix.Stt.dll #mobile #mobile-emul #tv
-Tizen.Uix.SttEngine.dll #mobile #mobile-emul
-Tizen.Uix.Tts.dll #mobile #mobile-emul #tv
-Tizen.Uix.TtsEngine.dll #mobile #mobile-emul
-Tizen.Uix.VoiceControl.dll #mobile #mobile-emul #tv #ivi
+Tizen.Uix.Stt.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Uix.SttEngine.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Uix.Tts.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Uix.TtsEngine.dll #common #mobile #mobile-emul #tv #ivi #wearable
+Tizen.Uix.VoiceControl.dll #common #mobile #mobile-emul #tv #ivi #wearable
Tizen.WebView.dll #common #mobile #mobile-emul #tv #ivi #wearable
internal static partial class Libteec
{
/// <summary>
- /// This function initializes a new TEE Context, forming a connection between this Client Application and the
+ /// This function initializes a new TEE Context, forming a connection between this client application and the
/// TEE identified by the string identifier name.
- /// The Client Application MAY pass name with a value of NULL, which means that the Implementation MUST
+ /// The client application may pass a name with a value of null, which means that the implementation must
/// select a default TEE to connect to. The supported name strings, the mapping of these names to a specific
/// TEE, and the nature of the default TEE are implementation-defined.
/// </summary>
static public extern int InitializeContext(string name, ref TEEC_Context context);
/// <summary>
- /// This function destroys an initialized TEE Context, closing the connection between the Client Application
- /// and the TEE. The Client Application MUST only call this function when all Sessions inside this TEE
- /// Context have been closed and all Shared Memory blocks have been released.
- /// The implementation of this function MUST NOT be able to fail; after this function returns the Client
- /// Application must be able to consider that the Context has been closed.
- /// The function implementation MUST do nothing if the value of the context pointer is NULL.
+ /// This function destroys an initialized TEE Context, closing the connection between the client application
+ /// and the TEE. The client application must only call this function when all sessions inside this TEE
+ /// context have been closed and all shared memory blocks have been released.
+ /// The implementation of this function must not fail; after this function returns, the client
+ /// application must be able to consider that the context has been closed.
+ /// The function implementation must do nothing if the value of the context pointer is null.
/// </summary>
//void TEEC_FinalizeContext(TEEC_Context *context);
[DllImport(Libraries.Libteec, EntryPoint = "TEEC_FinalizeContext", CallingConvention = CallingConvention.Cdecl)]
static public extern void FinalizeContext(ref TEEC_Context context);
/// <summary>
- /// This function registers a block of existing Client Application memory as a block of Shared Memory within
+ /// This function registers a block of existing client application memory as a block of shared memory within
/// the scope of the specified TEE Context, in accordance with the parameters which have been set by the
- /// Client Application inside the sharedMem structure.
- /// The input context MUST point to an initialized TEE Context.
- /// The input sharedMem MUST point to the Shared Memory structure defining the memory region to register
+ /// client application inside the shared memory structure.
+ /// The input context must point to an initialized TEE Context.
+ /// The input shared Memory must point to the shared memory structure defining the memory region to register.
/// </summary>
//EEC_Result TEEC_RegisterSharedMemory(TEEC_Context *context, TEEC_SharedMemory *sharedMem);
[DllImport(Libraries.Libteec, EntryPoint = "TEEC_RegisterSharedMemory", CallingConvention = CallingConvention.Cdecl)]
static public extern int RegisterSharedMemory(ref TEEC_Context context, ref TEEC_SharedMemory sharedMem);
/// <summary>
- /// This function allocates a new block of memory as a block of Shared Memory within the scope of the
- /// specified TEE Context, in accordance with the parameters which have been set by the Client Application
- /// inside the sharedMem structure.
- /// The input context MUST point to an initialized TEE Context.
- /// The input sharedMem MUST point to the Shared Memory structure defining the region to allocate.
+ /// This function allocates a new block of memory as a block of shared memory within the scope of the
+ /// specified TEE Context, in accordance with the parameters which have been set by the client application
+ /// inside the shared memory structure.
+ /// The input context must point to an initialized TEE Context.
+ /// The input shared memory must point to the shared memory structure defining the region to allocate.
/// </summary>
//TEEC_Result TEEC_AllocateSharedMemory(TEEC_Context *context, TEEC_SharedMemory *sharedMem);
[DllImport(Libraries.Libteec, EntryPoint = "TEEC_AllocateSharedMemory", CallingConvention = CallingConvention.Cdecl)]
static public extern int AllocateSharedMemory(ref TEEC_Context context, ref TEEC_SharedMemory sharedMem);
/// <summary>
- /// This function deregisters or deallocates a previously initialized block of Shared Memory.
- /// For a memory buffer allocated using AllocateSharedMemory the Implementation MUST free the
- /// underlying memory and the Client Application MUST NOT access this region after this function has been
- /// called. In this case the Implementation MUST set the buffer and size fields of the sharedMem
- /// structure to NULL and 0 respectively before returning.
- /// For memory registered using RegisterSharedMemory the implementation MUST deregister the
- /// underlying memory from the TEE, but the memory region will stay available to the Client Application for
+ /// This function deregisters or deallocates a previously initialized block of the shared memory.
+ /// For a memory buffer allocated using AllocateSharedMemory, the implementation must free the
+ /// underlying memory and the client application must not access this region after this function has been
+ /// called. In this case, the implementation must set the buffer and size fields of the shared memory
+ /// structure to null and 0 respectively before returning.
+ /// For memory registered using RegisterSharedMemory, the implementation must deregister the
+ /// underlying memory from the TEE, but the memory region will stay available to the client application for
/// other purposes as the memory is owned by it.
- /// The implementation MUST do nothing if the value of the sharedMem parameter is NULL.
+ /// The implementation must do nothing if the value of the shared memory parameter is null.
/// </summary>
//void TEEC_ReleaseSharedMemory(TEEC_SharedMemory *sharedMem);
[DllImport(Libraries.Libteec, EntryPoint = "TEEC_ReleaseSharedMemory", CallingConvention = CallingConvention.Cdecl)]
static public extern void ReleaseSharedMemory(ref TEEC_SharedMemory sharedMem);
/// <summary>
- /// This function opens a new Session between the Client Application and the specified Trusted Application.
- /// The Implementation MUST assume that all fields of this session structure are in an undefined state.
- /// When this function returns TEEC_SUCCESS the Implementation MUST have populated this structure with
- /// any information necessary for subsequent operations within the Session.
- /// The target Trusted Application is identified by a UUID passed in the parameter destination.
+ /// This function opens a new session between the client application and the specified trusted application.
+ /// The implementation must assume that all fields of this session structure are in an undefined state.
+ /// When this function returns TEEC_SUCCESS, the implementation must have populated this structure with
+ /// any information necessary for subsequent operations within the session.
+ /// The target trusted application is identified by the UUID passed in the parameter destination.
/// </summary>
//TEEC_Result TEEC_OpenSession(TEEC_Context *context, TEEC_Session *session, const TEEC_UUID *destination, uint connectionMethod, const void *connectionData, TEEC_Operation *operation, uint *returnOrigin);
[DllImport(Libraries.Libteec, EntryPoint = "TEEC_OpenSession", CallingConvention = CallingConvention.Cdecl)]
static public extern int OpenSession(ref TEEC_Context context, ref TEEC_Session session, TEEC_UUID destination, uint connectionMethod, byte[] connectionData, ref TEEC_Operation operation, out uint returnOrigin);
/// <summary>
- /// This function closes a Session which has been opened with a Trusted Application.
- /// All Commands within the Session MUST have completed before this function can be called.
- /// The Implementation MUST do nothing if the input session parameter is NULL.
- /// The implementation of this function MUST NOT be able to fail; after this function returns the Client
- /// Application must be able to consider that the Session has been closed.
+ /// This function closes a session which has been opened with a trusted application.
+ /// All commands within the session must have completed before this function can be called.
+ /// The implementation must do nothing if the input session parameter is null.
+ /// The implementation of this function must not fail; after this function returns, the Client
+ /// Application must be able to consider that the session has been closed.
/// </summary>
//void TEEC_CloseSession(TEEC_Session *session);
[DllImport(Libraries.Libteec, EntryPoint = "TEEC_CloseSession", CallingConvention = CallingConvention.Cdecl)]
static public extern void CloseSession(ref TEEC_Session session);
/// <summary>
- /// This function invokes a Command within the specified Session.
- /// The parameter session MUST point to a valid open Session.
+ /// This function invokes a command within the specified session.
+ /// The parameter session must point to a valid open session.
/// The parameter commandID is an identifier that is used to indicate which of the exposed Trusted
/// Application functions should be invoked. The supported command identifier values are defined by the
- /// Trusted Application‟s protocol.
+ /// trusted application's protocol.
/// </summary>
//TEEC_Result TEEC_InvokeCommand(TEEC_Session *session, uint commandID, TEEC_Operation *operation, uint *returnOrigin);
[DllImport(Libraries.Libteec, EntryPoint = "TEEC_InvokeCommand", CallingConvention = CallingConvention.Cdecl)]
static public extern int InvokeCommand(ref TEEC_Session session, uint commandID, ref TEEC_Operation operation, out uint returnOrigin);
/// <summary>
- /// This function requests the cancellation of a pending open Session operation or a Command invocation
+ /// This function requests the cancelation of a pending open session operation or a command invocation
/// operation. As this is a synchronous API, this function must be called from a thread other than the one
/// executing the OpenSession or InvokeCommand function.
- /// This function just sends a cancellation signal to the TEE and returns immediately; the operation is not
- /// guaranteed to have been cancelled when this function returns. In addition, the cancellation request is just
- /// a hint; the TEE or the Trusted Application MAY ignore the cancellation request.
+ /// This function just sends a cancelation signal to the TEE and returns immediately; the operation is not
+ /// guaranteed to have been canceled when this function returns. In addition, the cancelation request is just
+ /// a hint; the TEE or the trusted application may ignore the cancelation request.
/// </summary>
//void TEEC_RequestCancellation(TEEC_Operation *operation);
[DllImport(Libraries.Libteec, EntryPoint = "TEEC_RequestCancellation", CallingConvention = CallingConvention.Cdecl)]
namespace Tizen.Security.TEEC
{
/// <summary>
- /// This type denotes Session Login Method used in OpenSession
+ /// This type denotes the Session Login Method used in OpenSession.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class LoginMethod
{
/// <summary>No login data is provided.</summary>
public const uint Public = 0x00000000;
- /// <summary>Login data about the user running the Client Application process is provided.</summary>
+ /// <summary>Login data about the user running the client application process is provided.</summary>
public const uint User = 0x00000001;
- /// <summary>Login data about the group running the Client Application process is provided.</summary>
+ /// <summary>Login data about the group running the client application process is provided.</summary>
public const uint Group = 0x00000002;
- /// <summary>Login data about the running Client Application itself is provided.</summary>
+ /// <summary>Login data about the running client application itself is provided.</summary>
public const uint Application = 0x00000003;
}
/// <summary>
- /// This type denotes Value parameter
+ /// This type denotes the Value parameter.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum TEFValueType : UInt32
{
- /// <summary>The Parameter is a ValueType tagged as input.</summary>
+ /// <summary>The parameter is a ValueType tagged as the input.</summary>
Input = 0x00000001,
- /// <summary>The Parameter is a ValueType tagged as output.</summary>
+ /// <summary>The parameter is a ValueType tagged as the output.</summary>
Output = 0x00000002,
- /// <summary>The Parameter is a ValueType tagged as both as input and output.</summary>
+ /// <summary>The parameter is a ValueType tagged as both the input and the output.</summary>
InOut = 0x00000003,
}
/// <summary>
- /// This type denotes TempMemoryReference parameter
+ /// This type denotes the TempMemoryReference parameter
/// describing a region of memory which needs to be temporarily registered for the duration of the operation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum TEFTempMemoryType : UInt32
{
- /// <summary>The Parameter is a TempMemoryType and is tagged as input.</summary>
+ /// <summary>The parameter is a TempMemoryType and is tagged as the input.</summary>
Input = 0x00000005,
- /// <summary>Same as Input, but the Memory Reference is tagged as output.</summary>
+ /// <summary>Same as the input, but the Memory Reference is tagged as the output.</summary>
Output = 0x00000006,
- /// <summary>A Temporary Memory Reference tagged as both input and output.</summary>
+ /// <summary>A Temporary Memory Reference tagged as both the input and the output.</summary>
InOut = 0x00000007,
}
/// <summary>
- /// This type denotes SharedMemoryReference parameter
+ /// This type denotes the SharedMemoryReference parameter.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum TEFRegisteredMemoryType : UInt32
{
- /// <summary>The Parameter is a Registered Memory Reference that refers to the entirety of its parent Shared Memory block.</summary>
+ /// <summary>The parameter is a registered memory reference that refers to the entirety of its parent shared memory block.</summary>
Whole = 0x0000000C,
- /// <summary>A Registered Memory Reference structure that refers to a partial region of its parent Shared Memory block and is tagged as input.</summary>
+ /// <summary>A registered memory reference structure that refers to a partial region of its parent shared mMemory block and is tagged as the input.</summary>
PartialInput = 0x0000000D,
- /// <summary>A Registered Memory Reference structure that refers to a partial region of its parent Shared Memory block and is tagged as output.</summary>
+ /// <summary>A registered memory reference structure that refers to a partial region of its parent shared memory block and is tagged as the output.</summary>
PartialOutput = 0x0000000E,
- /// <summary>A Registered Memory Reference structure that refers to a partial region of its parent Shared Memory block and is tagged as both input and output.</summary>
+ /// <summary>A registered memory reference structure that refers to a partial region of its parent shared memory block and is tagged as both the input and the output.</summary>
PartialInOut = 0x0000000F,
}
/// <summary>
- /// This type denotes SharedMemory access direction
+ /// This type denotes the SharedMemory access direction.
/// </summary>
/// <since_tizen> 3 </since_tizen>
[Flags]
public enum SharedMemoryFlags : UInt32
{
- /// <summary>A flag indicates Shared Memory can be read.</summary>
+ /// <summary>A flag indicates the shared memory can be read.</summary>
Input = 0x00000001,
- /// <summary>A flag indicates Shared Memory can be written.</summary>
+ /// <summary>A flag indicates the shared memory can be written.</summary>
Output = 0x00000002,
- /// <summary>A flag indicates Shared Memory can be read and written.</summary>
+ /// <summary>A flag indicates the shared memory can be read and written.</summary>
InOut = Input | Output,
}
/// <summary>
- /// This type denotes a Shared Memory block which has either been registered
+ /// This type denotes a shared memory block which has been either registered
/// with the implementation or allocated by it.
/// </summary>
/// <since_tizen> 3 </since_tizen>
this.shm=shm;
}
/// <summary>
- /// This property represents shared memory size in bytes.
+ /// This property represents the shared memory size in bytes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public UInt32 Size
get { return shm.size; }
}
/// <summary>
- /// This property represents start address of shared memory block.
+ /// This property represents the start address of the shared memory block.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public IntPtr Address
/// <summary>
/// This function makes a copy and is designed for convenient operations on small buffers.
- /// For large buffers direct address should be used.
+ /// For large buffers, the direct address should be used.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="data">Source data buffer to copy data from</param>
- /// <param name="dstOffs">Starting offset in destination shared memory</param>
+ /// <param name="data">The source data buffer to copy data from.</param>
+ /// <param name="dstOffs">The starting offset in the destination shared memory.</param>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
public void SetData(byte[] data, int dstOffs)
{
}
/// <summary>
/// This function makes a copy and is designed for convenient operations on small buffers.
- /// For large buffers direct address should be used.
+ /// For large buffers, the direct address should be used.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="data">Destination data buffer to copy data into</param>
- /// <param name="srcOffs">Starting offset in source shared memory</param>
+ /// <param name="data">The destination data buffer to copy data into.</param>
+ /// <param name="srcOffs">The starting offset in the source shared memory.</param>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
public void GetData(byte[] data, int srcOffs)
{
};
/// <summary>
- /// This type defines the payload of either an open Session operation or an invoke Command operation. It is
- /// also used for cancellation of operations, which may be desirable even if no payload is passed.
- /// Parameters are used to exchange data between CA and TA
+ /// This type defines the payload of either an open session operation or an invoke command operation. It is
+ /// also used for cancelation of operations, which may be desirable even if no payload is passed.
+ /// Parameters are used to exchange data between CA and TA.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public abstract class Parameter
};
/// <summary>
- /// This type defines a template for parameter types.
+ /// This type defines a template for the parameter types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public abstract class BaseParameter<TEnum> : Parameter where TEnum : struct, IComparable, IFormattable, IConvertible // as close to Enum as possible
}
/// <summary>
- /// This property represents access type to this parameter.
+ /// This property represents the access type to this parameter.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public TEnum Type { get; }
public sealed class TempMemoryReference : BaseParameter<TEFTempMemoryType>
{
/// <summary>
- /// Constructs Prameter object which holds info about temporary memory copied to/from TA
+ /// Constructs a parameter object which holds information about the temporary memory copied to or from TA.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="buffer">Address of allocated memory buffer</param>
- /// <param name="size">Size of the buffer</param>
- /// <param name="type">Kind of access allowed for TA <see cref="TEFTempMemoryType"/></param>
+ /// <param name="buffer">The address of the allocated memory buffer.</param>
+ /// <param name="size">The size of the buffer.</param>
+ /// <param name="type">The kind of access allowed for TA <see cref="TEFTempMemoryType"/>.</param>
public TempMemoryReference(IntPtr buffer, uint size, TEFTempMemoryType type) :
base(type)
{
this.Size = size;
}
/// <summary>
- /// This property represents memory address of buffer.
+ /// This property represents the memory address of the buffer.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public IntPtr Buffer { get; }
/// <summary>
- /// This property represents size of buffer.
+ /// This property represents the size of the buffer.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public uint Size { get; }
};
/// <summary>
- /// This type defines a memory reference that uses a pre-registered or pre-allocated Shared Memory block.
+ /// This type defines a memory reference that uses a pre-registered or pre-allocated shared memory block.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public sealed class RegisteredMemoryReference : BaseParameter<TEFRegisteredMemoryType>
{
/// <summary>
- /// Constructs Prameter object which holds info about registered memory shared with TA
+ /// Constructs a parameter object which holds information about the registered memory shared with TA.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="parent">Shared memory - registered or allocated</param>
- /// <param name="size">Size of the buffer part</param>
- /// <param name="offset">Offset of buffer in shared memory</param>
- /// <param name="type">Kind of access allowed for TA <see cref="TEFRegisteredMemoryType"/></param>
+ /// <param name="parent">The shared memory - registered or allocated.</param>
+ /// <param name="size">The size of the buffer part.</param>
+ /// <param name="offset">The offset of the buffer in the shared memory.</param>
+ /// <param name="type">The kind of access allowed for TA <see cref="TEFRegisteredMemoryType"/>.</param>
public RegisteredMemoryReference(SharedMemory parent, uint size, uint offset, TEFRegisteredMemoryType type) :
base(type)
{
this.Offset = offset;
}
/// <summary>
- /// This property represents SharedMemory that is referred to.
+ /// This property represents the shared memory that is referred to.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public SharedMemory Parent { get; }
/// <summary>
- /// This property represents size (in bytes) of SharedMemory.
+ /// This property represents the size (in bytes) of the shared memory.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public uint Size { get; }
/// <summary>
- /// This property represents offset (in bytes) from the begin of SharedMemory.
+ /// This property represents the offset (in bytes) from the start of the shared memory.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public uint Offset { get; }
};
/// <summary>
- /// This type defines a parameter that is not referencing shared memory, but carries instead small raw data
- /// passed by value.
+ /// This type defines a parameter that is not referencing the shared memory, but carries instead small raw data
+ /// passed by a value.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public sealed class Value : BaseParameter<TEFValueType>
{
/// <summary>
- /// Constructs Prameter object which holds info about int values copied to/from TA
+ /// Constructs a parameter object which holds information about integer values copied to or from TA.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="a">User paramter A</param>
- /// <param name="b">User paramter B</param>
- /// <param name="type">Kind of access allowed for TA <see cref="TEFValueType"/></param>
+ /// <param name="a">User paramter A.</param>
+ /// <param name="b">User paramter B.</param>
+ /// <param name="type">The kind of access allowed for TA <see cref="TEFValueType"/>.</param>
public Value(uint a, uint b, TEFValueType type) :
base(type)
{
this.B = b;
}
/// <summary>
- /// This property represents unsigned integer A.
+ /// This property represents an unsigned integer A.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public uint A { get; }
/// <summary>
- /// This property represents unsigned integer B.
+ /// This property represents an unsigned integer B.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public uint B { get; }
/// <summary>
- /// This type denotes a TEE Session, the logical container linking a Client Application with a particular Trusted Application.
+ /// This type denotes a TEE Session, the logical container linking a client application with a particular trusted application.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public sealed class Session
}
/// <summary>
- /// This function closes a Session which has been opened with a Trusted Application.
- /// All Commands within the Session MUST have completed before this function can be called.
+ /// This function closes a session which has been opened with a trusted application.
+ /// All commands within the session must be completed before this function can be called.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
public void Close() {
}
/// <summary>
- /// This function invokes a Command within the specified Session.
- /// The parameter commandID is an identifier that is used to indicate which of the exposed Trusted
- /// Application functions should be invoked. The supported command identifier values are defined by the
- /// Trusted Application's protocol.
- /// There can be up to four Parameter objects given in the <paramref name="paramlist"/> array
+ /// This function invokes a command within the specified session.
+ /// The parameter commandID is an identifier that is used to indicate which of the exposed trusted
+ /// application functions should be invoked. The supported command identifier values are defined by the
+ /// trusted application's protocol.
+ /// There can be up to four parameter objects given in the <paramref name="paramlist"/> array.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="commandID">The command</param>
- /// <param name="paramlist">The array of parameters</param>
+ /// <param name="commandID">The command.</param>
+ /// <param name="paramlist">The array of parameters.</param>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
- /// <exception cref="ArgumentException">The argument <paramref name="paramlist"/> is wrong</exception>
+ /// <exception cref="ArgumentException">The argument <paramref name="paramlist"/> is wrong.</exception>
public void InvokeCommand(uint commandID, Parameter[] paramlist)
{
Interop.TEEC_Operation op = new Interop.TEEC_Operation();
}
/// <summary>
- /// Asynchronous version of InvokeCommand
+ /// The asynchronous version of the InvokeCommand.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="commandID">The command</param>
- /// <param name="paramlist">The array of parameters</param>
- /// <param name="token">The token for task manipulation</param>
- /// <returns>Returns Task executing invoke command in backgroung</returns>
+ /// <param name="commandID">The command.</param>
+ /// <param name="paramlist">The array of parameters.</param>
+ /// <param name="token">The token for task manipulation.</param>
+ /// <returns>Returns a task executing an invoke command in the background.</returns>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
- /// <exception cref="ArgumentException">One of arguments is wrong</exception>
+ /// <exception cref="ArgumentException">One of the arguments is wrong.</exception>
public async Task InvokeCommandAsync(uint commandID, Parameter[] paramlist, CancellationToken token = default(CancellationToken))
{
await Task.Factory.StartNew(() => InvokeCommand(commandID, paramlist));
private Interop.TEEC_Context context;
/// <summary>
- /// This function (constructor) initializes a new TEE Context, forming a connection between this Client Application and the
- /// TEE identified by the string identifier name (empty or null name denotes default TEE).
+ /// This function (constructor) initializes a new TEE Context, forming a connection between this client application and the
+ /// TEE identified by the string identifier name (empty or null name denotes a default TEE).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="name">The TEE name</param>
+ /// <param name="name">The TEE name.</param>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
public Context(string name)
}
/// <summary>
- /// This function implements IDisposable interface
+ /// This function implements the IDisposable interface.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
}
/// <summary>
- /// This function opens a new Session between the Client Application and the specified Trusted Application.
- /// The target Trusted Application is identified by a UUID passed in the parameter destination.
- /// There can be up to four Parameter objects given in the <paramref name="paramlist"/> array
+ /// This function opens a new session between the client application and the specified trusted application.
+ /// The target trusted application is identified by an UUID passed in the parameter destination.
+ /// There can be up to four parameter objects given in the <paramref name="paramlist"/> array.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="destination">The UUID of destination TA</param>
- /// <param name="loginMethod">The authentication algorithm <see cref="LoginMethod" /></param>
- /// <param name="connectionData">The data to be verified by given login method</param>
- /// <param name="paramlist">The parameters to be passed to TA open-session-callback</param>
- /// <returns>Returns opened session</returns>
+ /// <param name="destination">The UUID of the destination TA.</param>
+ /// <param name="loginMethod">The authentication algorithm <see cref="LoginMethod" />.</param>
+ /// <param name="connectionData">The data to be verified by a given login method.</param>
+ /// <param name="paramlist">The parameters to be passed to TA open-session-callback.</param>
+ /// <returns>Returns opened session.</returns>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
- /// <exception cref="ArgumentException">One of arguments is wrong</exception>
+ /// <exception cref="ArgumentException">One of the arguments is wrong.</exception>
public Session OpenSession(Guid destination, uint loginMethod, byte[] connectionData, Parameter[] paramlist)
{
Session ses = new Session(context);
return ses;
}
/// <summary>
- /// @see OpenSession(Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token)
+ /// @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="destination">The UUID of destination TA</param>
- /// <returns>Returns opened session</returns>
+ /// <param name="destination">The UUID of the destination TA.</param>
+ /// <returns>Returns opened session.</returns>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
public Session OpenSession(Guid destination)
}
/// <summary>
- /// Asynchronous version of OpenSession
- /// @see OpenSession(Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token)
+ /// The asynchronous version of the OpenSession.
+ /// @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="destination">The UUID of destination TA</param>
- /// <param name="loginMethod">The authentication algorithm <see cref="LoginMethod" /></param>
- /// <param name="connectionData">The data to be verified by given login method</param>
- /// <param name="paramlist">The parameters to be passed to TA open-session-callback</param>
- /// <param name="token">The token for task manipulation</param>
- /// <returns>Returns Task executing session open in backgroung</returns>
+ /// <param name="destination">The UUID of the destination TA.</param>
+ /// <param name="loginMethod">The authentication algorithm <see cref="LoginMethod" />.</param>
+ /// <param name="connectionData">The data to be verified by a given login method.</param>
+ /// <param name="paramlist">The parameters to be passed to the TA open-session-callback.</param>
+ /// <param name="token">The token for the task manipulation.</param>
+ /// <returns>Returns a Task executing the session open in the background.</returns>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
- /// <exception cref="ArgumentException">One of arguments is wrong</exception>
+ /// <exception cref="ArgumentException">One of the arguments is wrong.</exception>
public async Task<Session> OpenSessionAsync(Guid destination, uint loginMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token = default(CancellationToken))
{
Task<Session> task = Task<Session>.Factory.StartNew(() =>
return await task;
}
/// <summary>
- /// Asynchronous version of OpenSession
- /// @see OpenSession(Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token)
+ /// The asynchronous version of the OpenSession.
+ /// @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="destination">The UUID of destination TA</param>
- /// <param name="token">The token for task manipulation</param>
- /// <returns>Returns Task executing session open in backgroung</returns>
+ /// <param name="destination">The UUID of the destination TA.</param>
+ /// <param name="token">The token for a task manipulation.</param>
+ /// <returns>Returns a task executing session open in the background.</returns>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
public async Task<Session> OpenSessionAsync(Guid destination, CancellationToken token = default(CancellationToken))
}
/// <summary>
- /// This function registers a block of existing Client Application memory as a block of Shared Memory within
- /// the scope of the specified Context, in accordance with the parameters.
- /// The input <paramref name="memaddr"/> MUST point to the shared memory region to register
+ /// This function registers a block of the existing client application memory as a block of shared memory within
+ /// the scope of the specified context, in accordance with the parameters.
+ /// The input <paramref name="memaddr"/> must point to the shared memory region to register.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="memaddr">The address of shared memory</param>
- /// <param name="size">The size of shared memory</param>
- /// <param name="flags">The flags describing access modes (Input and/or Output)</param>
- /// <returns>Returns SharedMemory handler</returns>
+ /// <param name="memaddr">The address of the shared memory.</param>
+ /// <param name="size">The size of the shared memory.</param>
+ /// <param name="flags">The flags describing the access modes (Input and/or Output).</param>
+ /// <returns>Returns the SharedMemory handler.</returns>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
- /// <exception cref="ArgumentException">The argument <paramref name="memaddr"/> is wrong</exception>
+ /// <exception cref="ArgumentException">The argument <paramref name="memaddr"/> is wrong.</exception>
public SharedMemory RegisterSharedMemory(IntPtr memaddr, UInt32 size, SharedMemoryFlags flags)
{
Interop.TEEC_SharedMemory shm = new Interop.TEEC_SharedMemory();
}
/// <summary>
- /// This function allocates a new block of memory as a block of Shared Memory within the scope of the
- /// specified Context, in accordance with the parameters.
+ /// This function allocates a new block of memory as a block of shared memory within the scope of the
+ /// specified context, in accordance with the parameters.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="size">The size of shared memory</param>
- /// <param name="flags">The flags describing access modes (Input and/or Output)</param>
- /// <returns>Returns SharedMemory handler</returns>
+ /// <param name="size">The size of shared memory.</param>
+ /// <param name="flags">The flags describing access modes (Input and/or Output).</param>
+ /// <returns>Returns the Shared Memory handler.</returns>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
public SharedMemory AllocateSharedMemory(UInt32 size, SharedMemoryFlags flags)
}
/// <summary>
- /// This function deregisters or deallocates a previously initialized block of Shared Memory.
+ /// This function deregisters or deallocates a previously initialized block of the shared memory.
/// </summary>
/// <remarks>
- /// For a memory buffer allocated using AllocateSharedMemory the Implementation MUST free the
- /// underlying memory and the Client Application MUST NOT access this region after this function has been
- /// called. In this case the Implementation MUST clear the buffer and size fields of the sharedMem
+ /// For a memory buffer allocated using AllocateSharedMemory, the implementation must free the
+ /// underlying memory and the client application must not access this region after this function has been
+ /// called. In this case, the implementation must clear the buffer and size fields of the shared memory
/// structure before returning.
- /// For memory registered using RegisterSharedMemory the implementation MUST deregister the
- /// underlying memory from the TEE, but the memory region will stay available to the Client Application for
+ /// For memory registered using RegisterSharedMemory, the implementation must deregister the
+ /// underlying memory from the TEE, but the memory region will stay available to the client application for
/// other purposes as the memory is owned by it.
/// </remarks>
/// <since_tizen> 3 </since_tizen>
- /// <param name="shm">The shared memory object returned by RegisterSharedMemory or AllocateSharedMemory</param>
+ /// <param name="shm">The shared memory object returned by RegisterSharedMemory or AllocateSharedMemory.</param>
/// <privilege>http://tizen.org/privilege/tee.client</privilege>
/// <privlevel>partner</privlevel>
/// <feature>http://tizen.org/feature/security.tee</feature>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have privilege to access this method.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">The operation is invalid.</exception>
- /// <exception cref="ArgumentException">The argument is wrong</exception>
+ /// <exception cref="ArgumentException">The argument is wrong.</exception>
public void ReleaseSharedMemory(SharedMemory shm)
{
Interop.Libteec.ReleaseSharedMemory(ref shm.shm);
The TEE Client API concentrates on the interface to enable efficient communications between
a Client Application and a Trusted Application running inside the TEE.
Higher level standards and protocol layers may be built on top of the foundation
-provided by the TEE Client API – for example, to cover common tasks such as secure storage,
+provided by the TEE Client API – for example, to cover common tasks, such as secure storage,
cryptography, and run-time installation of new Trusted Applications.
The separation between the rich environment and the TEE is guaranted.
</para>
<description>
Where possible the design of the TEE Client API has placed the responsibility for memory
allocation on the calling Client Application code. This gives the Client developer choice of
- memory allocation locations, enabling simple optimizations such as stack-based allocation
+ memory allocation locations, enabling simple optimizations, such as stack-based allocation
or enhanced flexibility using placements in static global memory or thread-local storage.<br />
This design choice is evident in the API by the use of pointers to structures rather than
opaque handles to represent any manipulated objects.
namespace Tizen.System
{
/// <summary>
- /// The System Settings API provides APIs for sharing configuration over a system
+ /// The System Settings API provides APIs for sharing the configuration over a system.
/// </summary>
/// <remarks>
- /// System Settings API provides functions for getting the system configuration related to user preferences.
- /// The main features of the System Settings API include accessing system-wide configurations, such as ringtones, wallpapers, and etc
+ /// The System Settings API provides functions for getting the system configuration related to user preferences.
+ /// The main features of the System Settings API include accessing system-wide configurations, such as ringtones, wallpapers, and so on.
/// </remarks>
public static class SystemSettings
{
/// <summary>
- /// The file path of the current ringtone
+ /// The file path of the current ringtone.
/// </summary>
public static string IncomingCallRingtone
{
}
/// <summary>
- /// The file path of the current home screen wallpaper
+ /// The file path of the current home-screen wallpaper.
/// </summary>
public static string WallpaperHomeScreen
{
}
/// <summary>
- /// The file path of the current lock screen wallpaper
+ /// The file path of the current lock-screen wallpaper.
/// </summary>
public static string WallpaperLockScreen
{
}
/// <summary>
- /// The current system font size
+ /// The current system font size.
/// </summary>
public static SystemSettingsFontSize FontSize
{
}
/// <summary>
- /// The current system font type
+ /// The current system font type.
/// </summary>
public static string FontType
{
}
/// <summary>
- /// Indicates whether the motion service is activated
+ /// Indicates whether the motion service is activated.
/// </summary>
public static bool MotionActivationEnabled
{
}
/// <summary>
- /// The file path of the current email alert ringtone
+ /// The file path of the current email alert ringtone.
/// </summary>
public static string EmailAlertRingtone
{
}
}
/// <summary>
- /// Indicates whether the USB debugging is enabled
+ /// Indicates whether the USB debugging is enabled.
/// </summary>
public static bool UsbDebuggingEnabled
{
}
/// <summary>
- /// Indicates whether the 3G data network is enabled
+ /// Indicates whether the 3G data network is enabled.
/// </summary>
public static bool Data3GNetworkEnabled
{
}
/// <summary>
- /// Indicates lockscreen app pkg name
+ /// Indicates the lock-screen application package name.
/// </summary>
public static string LockscreenApp
{
}
/// <summary>
- /// The current system default font type (only support Get)
+ /// The current system default font type (only supports Get).
/// </summary>
public static string DefaultFontType
{
/// <summary>
/// Indicates the current country setting in the <LANGUAGE>_<REGION> syntax.
/// The country setting is in the ISO 639-2 format,
- /// and the region setting is in the ISO 3166-1 alpha-2 format
+ /// and the region setting is in the ISO 3166-1 alpha-2 format.
/// </summary>
public static string LocaleCountry
{
/// <summary>
/// Indicates the current language setting in the <LANGUAGE>_<REGION> syntax.
- /// The language setting is in the ISO 639-2 format
+ /// The language setting is in the ISO 639-2 format,
/// and the region setting is in the ISO 3166-1 alpha-2 format.
/// </summary>
public static string LocaleLanguage
}
/// <summary>
- /// Indicates the current time zone. Eg. "Pacific/Tahiti"
+ /// Indicates the current time zone, for example, Pacific/Tahiti.
/// </summary>
public static string LocaleTimeZone
{
}
/// <summary>
- /// Once System changes time, this event occurs to notify time change.
+ /// Once the system changes time, this event occurs to notify the time change.
/// </summary>
public static int Time
{
}
}
/// <summary>
- /// Indicates whether the screen lock sound is enabled on the device. ex) LCD on/off sound
+ /// Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound.
/// </summary>
public static bool SoundLockEnabled
{
}
/// <summary>
- /// Indicates whether rotation control is automatic.
+ /// Indicates whether the rotation control is automatic.
/// </summary>
public static bool DisplayScreenRotationAutoEnabled
{
}
/// <summary>
- /// Indicates device name.
+ /// Indicates the device name.
/// </summary>
public static string DeviceName
{
}
}
/// <summary>
- /// Indicates whether the device user has enabled motion feature.
+ /// Indicates whether the device user has enabled the motion feature.
/// </summary>
public static bool MotionEnabled
{
}
/// <summary>
- /// Indicates whether Wi-Fi-related notifications are enabled on the device.
+ /// Indicates whether Wi-Fi related notifications are enabled on the device.
/// </summary>
public static bool NetworkWifiNotificationEnabled
{
}
/// <summary>
- /// Indicates the current lock state
+ /// Indicates the current lock state.
/// </summary>
public static SystemSettingsIdleLockState LockState
{
}
/// <summary>
- /// The current system ADS ID
+ /// The current system ADS ID.
/// </summary>
public static string AdsId
{
};
private static event EventHandler<IncomingCallRingtoneChangedEventArgs> s_incomingCallRingtoneChanged;
/// <summary>
- /// IncomingCallRingtoneChanged event is triggered when the file path of the incoming ringtone is changed
+ /// The IncomingCallRingtoneChanged event is triggered when the file path of the incoming ringtone is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A IncomingCallRingtoneChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The IncomingCallRingtoneChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<IncomingCallRingtoneChangedEventArgs> IncomingCallRingtoneChanged
{
add
};
private static event EventHandler<WallpaperHomeScreenChangedEventArgs> s_wallpaperHomeScreenChanged;
/// <summary>
- /// WallpaperHomeScreenChanged event is triggered when the file path of the current home screen wallpaper is changed
+ /// THe WallpaperHomeScreenChanged event is triggered when the file path of the current home screen wallpaper is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A WallpaperHomeScreenChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The WallpaperHomeScreenChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<WallpaperHomeScreenChangedEventArgs> WallpaperHomeScreenChanged
{
add
};
private static event EventHandler<WallpaperLockScreenChangedEventArgs> s_wallpaperLockScreenChanged;
/// <summary>
- /// WallpaperLockScreenChanged event is triggered when the file path of the current lock screen wallpaper is changed
+ /// The WallpaperLockScreenChanged event is triggered when the file path of the current lock screen wallpaper is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A WallpaperLockScreenChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The WallpaperLockScreenChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<WallpaperLockScreenChangedEventArgs> WallpaperLockScreenChanged
{
add
};
private static event EventHandler<FontSizeChangedEventArgs> s_fontSizeChanged;
/// <summary>
- /// FontSizeChanged event is triggered when the current system font size is changed
+ /// The FontSizeChanged event is triggered when the current system font size is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A FontSizeChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The FontSizeChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<FontSizeChangedEventArgs> FontSizeChanged
{
add
};
private static event EventHandler<FontTypeChangedEventArgs> s_fontTypeChanged;
/// <summary>
- /// FontTypeChanged event is triggered when the current system font type is changed
+ /// The FontTypeChanged event is triggered when the current system font type is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A FontTypeChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The FontTypeChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<FontTypeChangedEventArgs> FontTypeChanged
{
add
};
private static event EventHandler<MotionActivationSettingChangedEventArgs> s_motionActivationChanged;
/// <summary>
- /// MotionActivationChanged event is triggered when the motion service status is changed
+ /// The MotionActivationChanged event is triggered when the motion service status is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A MotionActivationChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The MotionActivationChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<MotionActivationSettingChangedEventArgs> MotionActivationSettingChanged
{
add
};
private static event EventHandler<EmailAlertRingtoneChangedEventArgs> s_emailAlertRingtoneChanged;
/// <summary>
- /// EmailAlertRingtoneChanged event is triggered when the file path of the current email alert ringtone is changed
+ /// The EmailAlertRingtoneChanged event is triggered when the file path of the current email alert ringtone is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A EmailAlertRingtoneChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The EmailAlertRingtoneChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<EmailAlertRingtoneChangedEventArgs> EmailAlertRingtoneChanged
{
add
};
private static event EventHandler<UsbDebuggingSettingChangedEventArgs> s_usbDebuggingSettingChanged;
/// <summary>
- /// UsbDebuggingSettingChangedEventArgs event is triggered when the USB debugging status is changed
+ /// The UsbDebuggingSettingChangedEventArgs event is triggered when the USB debugging status is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A UsbDebuggingSettingChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The UsbDebuggingSettingChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<UsbDebuggingSettingChangedEventArgs> UsbDebuggingSettingChanged
{
add
};
private static event EventHandler<Data3GNetworkSettingChangedEventArgs> s_data3GNetworkSettingChanged;
/// <summary>
- /// Data3GNetworkSettingChanged event is triggered when the 3G data network status is changed
+ /// The Data3GNetworkSettingChanged event is triggered when the 3G data network status is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A Data3GNetworkSettingChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The Data3GNetworkSettingChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<Data3GNetworkSettingChangedEventArgs> Data3GNetworkSettingChanged
{
add
};
private static event EventHandler<LockscreenAppChangedEventArgs> s_lockscreenAppChanged;
/// <summary>
- /// LockscreenAppChanged event is triggered when the lockscreen app pkg name is changed
+ /// The LockscreenAppChanged event is triggered when the lockscreen application package name is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A LockscreenAppChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The LockscreenAppChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<LockscreenAppChangedEventArgs> LockscreenAppChanged
{
add
};
private static event EventHandler<LocaleCountryChangedEventArgs> s_localeCountryChanged;
/// <summary>
- /// LocaleCountryChanged event is triggered when the current country setting in the <LANGUAGE>_<REGION> syntax, is changed
+ /// The LocaleCountryChanged event is triggered when the current country setting in the <LANGUAGE>_<REGION> syntax, is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A LocaleCountryChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The LocaleCountryChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<LocaleCountryChangedEventArgs> LocaleCountryChanged
{
add
};
private static event EventHandler<LocaleLanguageChangedEventArgs> s_localeLanguageChanged;
/// <summary>
- /// LocaleLanguageChanged event is triggered when the current language setting in the <LANGUAGE>_<REGION> syntax, is changed
+ /// The LocaleLanguageChanged event is triggered when the current language setting in the <LANGUAGE>_<REGION> syntax, is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A LocaleLanguageChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The LocaleLanguageChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<LocaleLanguageChangedEventArgs> LocaleLanguageChanged
{
add
};
private static event EventHandler<LocaleTimeFormat24HourSettingChangedEventArgs> s_localeTimeFormat24HourChanged;
/// <summary>
- /// LocaleTimeFormat24HourChanged event is triggered when the time format is changed
+ /// The LocaleTimeFormat24HourChanged event is triggered when the time format is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A LocaleTimeFormat24HourChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The LocaleTimeFormat24HourChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<LocaleTimeFormat24HourSettingChangedEventArgs> LocaleTimeFormat24HourSettingChanged
{
add
};
private static event EventHandler<LocaleTimeZoneChangedEventArgs> s_localeTimeZoneChanged;
/// <summary>
- /// LocaleTimeZoneChanged event is triggered when the current time zone is changed
+ /// The LocaleTimeZoneChanged event is triggered when the current time zone is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A LocaleTimeZoneChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The LocaleTimeZoneChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<LocaleTimeZoneChangedEventArgs> LocaleTimeZoneChanged
{
add
};
private static event EventHandler<TimeChangedEventArgs> s_timeChanged;
/// <summary>
- /// TimeChanged event is triggered when the system time is changed
+ /// The TimeChanged event is triggered when the system time is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A TimeChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The TimeChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<TimeChangedEventArgs> TimeChanged
{
add
};
private static event EventHandler<SoundLockSettingChangedEventArgs> s_soundLockChanged;
/// <summary>
- /// SoundLockChanged event is triggered when the screen lock sound enabled status is changed
+ /// The SoundLockChanged event is triggered when the screen lock sound enabled status is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A SoundLockChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The SoundLockChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<SoundLockSettingChangedEventArgs> SoundLockSettingChanged
{
add
};
private static event EventHandler<SoundSilentModeSettingChangedEventArgs> s_soundSilentModeChanged;
/// <summary>
- /// SoundSilentModeChanged event is triggered when the silent mode status is changed
+ /// The SoundSilentModeChanged event is triggered when the silent mode status is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A SoundSilentModeChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The SoundSilentModeChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<SoundSilentModeSettingChangedEventArgs> SoundSilentModeSettingChanged
{
add
};
private static event EventHandler<SoundTouchSettingChangedEventArgs> s_soundTouchChanged;
/// <summary>
- /// SoundTouchChanged event is triggered when the screen touch sound enabled status is changed
+ /// THe SoundTouchChanged event is triggered when the screen touch sound enabled status is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A SoundTouchChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The SoundTouchChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<SoundTouchSettingChangedEventArgs> SoundTouchSettingChanged
{
add
};
private static event EventHandler<DisplayScreenRotationAutoSettingChangedEventArgs> s_displayScreenRotationAutoChanged;
/// <summary>
- /// DisplayScreenRotationAutoChanged event is triggered when the automatic rotation control status is changed
+ /// The DisplayScreenRotationAutoChanged event is triggered when the automatic rotation control status is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A DisplayScreenRotationAutoChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The DisplayScreenRotationAutoChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<DisplayScreenRotationAutoSettingChangedEventArgs> DisplayScreenRotationAutoSettingChanged
{
add
};
private static event EventHandler<DeviceNameChangedEventArgs> s_deviceNameChanged;
/// <summary>
- /// DeviceNameChanged event is triggered when the device name is changed
+ /// The DeviceNameChanged event is triggered when the device name is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A DeviceNameChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The DeviceNameChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<DeviceNameChangedEventArgs> DeviceNameChanged
{
add
};
private static event EventHandler<MotionSettingChangedEventArgs> s_motionSettingChanged;
/// <summary>
- /// MotionSettingChanged event is triggered when the motion feature enabled status is changed
+ /// The MotionSettingChanged event is triggered when the motion feature enabled status is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A MotionSettingChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The MotionSettingChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<MotionSettingChangedEventArgs> MotionSettingChanged
{
add
};
private static event EventHandler<NetworkWifiNotificationSettingChangedEventArgs> s_networkWifiNotificationChanged;
/// <summary>
- /// NetworkWifiNotificationChanged event is triggered when the Wi-Fi-related notifications enabled status is changed
+ /// The NetworkWifiNotificationChanged event is triggered when the WiFi-related notifications enabled status is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A NetworkWifiNotificationChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The NetworkWifiNotificationChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<NetworkWifiNotificationSettingChangedEventArgs> NetworkWifiNotificationSettingChanged
{
add
};
private static event EventHandler<NetworkFlightModeSettingChangedEventArgs> s_networkFlightModeChanged;
/// <summary>
- /// NetworkFlightModeChanged event is triggered when the flight mode status is changed
+ /// The NetworkFlightModeChanged event is triggered when the flight mode status is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A NetworkFlightModeChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The NetworkFlightModeChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<NetworkFlightModeSettingChangedEventArgs> NetworkFlightModeSettingChanged
{
add
};
private static event EventHandler<ScreenBacklightTimeChangedEventArgs> s_screenBacklightTimeChanged;
/// <summary>
- /// ScreenBacklightTimeChanged event is triggered when the backlight time is changed.
+ /// THe ScreenBacklightTimeChanged event is triggered when the backlight time is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A ScreenBacklightTimeChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The ScreenBacklightTimeChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<ScreenBacklightTimeChangedEventArgs> ScreenBacklightTimeChanged
{
add
};
private static event EventHandler<SoundNotificationChangedEventArgs> s_soundNotificationChanged;
/// <summary>
- /// SoundNotificationChanged event is triggered when the file path of the current notification tone set by the user is changed
+ /// The SoundNotificationChanged event is triggered when the file path of the current notification tone set by the user is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A SoundNotificationChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The SoundNotificationChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<SoundNotificationChangedEventArgs> SoundNotificationChanged
{
add
};
private static event EventHandler<SoundNotificationRepetitionPeriodChangedEventArgs> s_soundNotificationRepetitionPeriodChanged;
/// <summary>
- /// SoundNotificationRepetitionPeriodChanged event is triggered when the time period for notification repetitions is changed
+ /// The SoundNotificationRepetitionPeriodChanged event is triggered when the time period for notification repetitions is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A SoundNotificationRepetitionPeriodChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The SoundNotificationRepetitionPeriodChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<SoundNotificationRepetitionPeriodChangedEventArgs> SoundNotificationRepetitionPeriodChanged
{
add
};
private static event EventHandler<LockStateChangedEventArgs> s_lockStateChanged;
/// <summary>
- /// LockStateChanged event is triggered when the current lock state is changed
+ /// The LockStateChanged event is triggered when the current lock state is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A LockStateChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The LockStateChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<LockStateChangedEventArgs> LockStateChanged
{
add
};
private static event EventHandler<AdsIdChangedEventArgs> s_adsIdChanged;
/// <summary>
- /// AdsIdChanged event is triggered when the current ADS ID state is changed
+ /// The AdsIdChanged event is triggered when the current ADS ID state is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A AdsIdChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The AdsIdChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<AdsIdChangedEventArgs> AdsIdChanged
{
add
};
private static event EventHandler<UltraDataSaveChangedEventArgs> s_ultraDataSaveChanged;
/// <summary>
- /// UltraDataSaveChanged event is triggered when the current Ultra Data Save state is changed
+ /// The UltraDataSaveChanged event is triggered when the current Ultra Data Save state is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A UltraDataSaveChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The UltraDataSaveChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<UltraDataSaveChangedEventArgs> UltraDataSaveChanged
{
add
};
private static event EventHandler<UltraDataSavePackageListChangedEventArgs> s_ultraDataSavePackageListChanged;
/// <summary>
- /// UltraDataSavePackageListChanged event is triggered when the current ADS ID state is changed
+ /// The UltraDataSavePackageListChanged event is triggered when the current ADS ID state is changed.
/// </summary>
/// <param name="sender"></param>
- /// <param name="e">A UltraDataSavePackageListChangedEventArgs object that contains the key & changed value</param>
+ /// <param name="e">The UltraDataSavePackageListChangedEventArgs object that contains the key and the changed value.</param>
public static event EventHandler<UltraDataSavePackageListChangedEventArgs> UltraDataSavePackageListChanged
{
add
namespace Tizen.System
{
/// <summary>
- /// Enumeration for all available system settings
+ /// Enumeration for all the available system settings.
/// </summary>
public enum SystemSettingsKeys : int
{
/// <summary>
- /// (string) The file path of the current ringtone
+ /// GET (string) The file path of the current ringtone.
/// </summary>
IncomingCallRingtone = 0,
/// <summary>
- /// (string) The file path of the current home screen wallpaper
+ /// GET (string) The file path of the current home-screen wallpaper.
/// </summary>
WallpaperHomeScreen,
/// <summary>
- /// (string) The file path of the current lock screen wallpaper
+ /// GET (string) The file path of the current lock-screen wallpaper.
/// </summary>
WallpaperLockScreen,
/// <summary>
- /// (int) The current system font size
+ /// GET (int) The current system font size.
/// </summary>
FontSize,
/// <summary>
- /// (string) The current system font type
+ /// GET (string) The current system font type.
/// </summary>
FontType,
/// <summary>
- /// (bool) Indicates whether the motion service is activated
+ /// GET (bool) Indicates whether the motion service is activated.
/// </summary>
MotionActivationEnabled,
/// <summary>
- /// (string) The file path of the current email alert ringtone
+ /// GET (string) The file path of the current email alert ringtone.
/// </summary>
EmailAlertRingtone,
/// <summary>
- /// (bool) Indicates whether the USB debugging is enabled
+ /// GET (bool) Indicates whether the USB debugging is enabled.
/// </summary>
UsbDebuggingEnabled,
/// <summary>
- /// (bool) Indicates whether the 3G data network is enabled
+ /// GET (bool) Indicates whether the 3G-data network is enabled.
/// </summary>
Data3GNetworkEnabled,
/// <summary>
- /// (string) Indicates lockscreen app pkg name
+ /// GET (string) Indicates the lock-screen application package name.
/// </summary>
LockscreenApp = Data3GNetworkEnabled + 2,
/// <summary>
- /// (string) The current system default font type (only support Get)
+ /// GET (string) The current system default font type (only supports Get).
/// </summary>
DefaultFontType,
/// <summary>
- /// (string) Indicates the current country setting in the <LANGUAGE>_<REGION> syntax.
+ /// GET (string) Indicates the current country setting in the <LANGUAGE>_<REGION> syntax.
/// The country setting is in the ISO 639-2 format,
- /// and the region setting is in the ISO 3166-1 alpha-2 format
+ /// and the region setting is in the ISO 3166-1 alpha-2 format.
/// </summary>
LocaleCountry,
/// <summary>
- /// (string) Indicates the current language setting in the <LANGUAGE>_<REGION> syntax.
- /// The language setting is in the ISO 639-2 format
+ /// GET (string) Indicates the current language setting in the <LANGUAGE>_<REGION> syntax.
+ /// The language setting is in the ISO 639-2 format,
/// and the region setting is in the ISO 3166-1 alpha-2 format.
/// </summary>
LocaleLanguage,
/// <summary>
- /// (bool) Indicates whether the 24-hour clock is used.
+ /// GET (bool) Indicates whether the 24-hour clock is used.
/// If the value is false, the 12-hour clock is used.
/// </summary>
LocaleTimeFormat24HourEnabled,
/// <summary>
- /// (string) Indicates the current time zone. Eg. Pacific/Tahiti
+ /// GET (string) Indicates the current time zone, for example, Pacific/Tahiti.
/// </summary>
LocaleTimeZone,
/// <summary>
- /// (int) Once System changes time, this event occurs to notify time change.
+ /// GET (int) Once system changes the time, this event occurs to notify the time change.
/// </summary>
Time,
/// <summary>
- /// GET (bool) Indicates whether the screen lock sound is enabled on the device. ex) LCD on/off sound
+ /// GET (bool) Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound.
/// </summary>
SoundLockEnabled,
/// <summary>
/// </summary>
SoundTouchEnabled,
/// <summary>
- /// GET (bool) Indicates whether rotation control is automatic.
+ /// GET (bool) Indicates whether the rotation control is automatic.
/// </summary>
DisplayScreenRotationAutoEnabled,
/// <summary>
- /// GET (string) Indicates device name.
+ /// GET (string) Indicates the device name.
/// </summary>
DeviceName,
/// <summary>
- /// GET (bool) Indicates whether the device user has enabled motion feature.
+ /// GET (bool) Indicates whether the device user has the enabled motion feature.
/// </summary>
MotionEnabled,
/// <summary>
- /// GET (bool) Indicates whether Wi-Fi-related notifications are enabled on the device.
+ /// GET (bool) Indicates whether WiFi-related notifications are enabled on the device.
/// </summary>
NetworkWifiNotificationEnabled,
/// <summary>
/// </summary>
NetworkFlightModeEnabled,
/// <summary>
- /// (int) Indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600.
+ /// GET (int) Indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600.
/// </summary>
ScreenBacklightTime,
/// <summary>
- /// (string) Indicates the file path of the current notification tone set by the user.
+ /// GET (string) Indicates the file path of the current notification tone set by the user.
/// </summary>
SoundNotification,
/// <summary>
- /// (int) Indicates the time period for notification repetitions.
+ /// GET (int) Indicates the time period for notification repetitions.
/// </summary>
SoundNotificationRepetitionPeriod,
/// <summary>
- /// (int) Indicates the current lock state
+ /// GET (int) Indicates the current lock state.
/// </summary>
LockState,
/// <summary>
- /// (string) Indicates Ads ID for each device
+ /// GET (string) Indicates the ADS ID for each device.
/// </summary>
AdsId,
/// <summary>
- /// (int) Indicates Ultra Data Save status, one of #SystemSettingsUdsState values
+ /// GET (int) Indicates the Ultra Data Save status, one of the #SystemSettingsUdsState values.
/// </summary>
UltraDataSave,
/// <summary>
- /// (string) Indicates Ultra Data Save Package List (Since 4.0), the list is a string containing whitelisted package names separated with semicolons (;)
+ /// GET (string) Indicates the Ultra Data Save Package List. Since 4.0, the list is a string containing whitelisted package names separated with semicolons (;).
/// </summary>
UltraDataSavePackageList
}
/// <summary>
- /// Enumeration for Idle Lock State.
+ /// Enumeration for the Idle Lock State.
/// </summary>
public enum SystemSettingsIdleLockState : int
{
/// <summary>
- /// Device is unlocked
+ /// The device is unlocked.
/// </summary>
Unlock = 0,
/// <summary>
- /// Device is locked
+ /// The device is locked.
/// </summary>
Lock,
/// <summary>
- /// Device is being locked
+ /// The device is being locked.
/// </summary>
LaunchingLock
}
/// <summary>
- /// Enumeration for font size.
+ /// Enumeration for the font size.
/// </summary>
public enum SystemSettingsFontSize : int
{
/// <summary>
- /// A small size
+ /// A small size.
/// </summary>
Small = 0,
/// <summary>
- /// A normal size
+ /// A normal size.
/// </summary>
Normal,
/// <summary>
- /// A large size
+ /// A large size.
/// </summary>
Large,
/// <summary>
- /// A huge size
+ /// A huge size.
/// </summary>
Huge,
/// <summary>
- /// A giant size
+ /// A giant size.
/// </summary>
Giant
}
/// <summary>
- /// Enumeration for ultra data save
+ /// Enumeration for the ultra data save.
/// </summary>
public enum SystemSettingsUdsState : int
{
/// <summary>
- /// UDS Off
+ /// UDS Off.
/// </summary>
UdsOff = 0,
/// <summary>
- /// UDS On
+ /// UDS On.
/// </summary>
UdsOn,
/// <summary>
- /// UDS On and the app is whitelisted
+ /// UDS On and the application is whitelisted.
/// </summary>
UdsOnWhitelisted,
}
namespace Tizen.System
{
/// <summary>
- /// EventArgs type for the event IncomingCallRingtoneChanged
+ /// EventArgs type for the IncomingCallRingtoneChanged event.
/// </summary>
public class IncomingCallRingtoneChangedEventArgs : EventArgs
{
}
/// <summary>
- /// The file path of the current ringtone
+ /// The file path of the current ringtone.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event WallpaperHomeScreenChanged
+ /// EventArgs type for the WallpaperHomeScreenChanged event.
/// </summary>
public class WallpaperHomeScreenChangedEventArgs : EventArgs
{
}
/// <summary>
- /// The file path of the current home screen wallpaper
+ /// The file path of the current home screen wallpaper.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event WallpaperLockScreenChanged
+ /// EventArgs type for the WallpaperLockScreenChanged event.
/// </summary>
public class WallpaperLockScreenChangedEventArgs : EventArgs
{
}
/// <summary>
- /// The file path of the current lock screen wallpaper
+ /// The file path of the current lock screen wallpaper.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event FontSizeChanged
+ /// EventArgs type for the FontSizeChanged event.
/// </summary>
public class FontSizeChangedEventArgs : EventArgs
{
}
/// <summary>
- /// The current system font size
+ /// The current system font size.
/// </summary>
public SystemSettingsFontSize Value
{
}
/// <summary>
- /// EventArgs type for the event FontTypeChanged
+ /// EventArgs type for the FontTypeChanged event.
/// </summary>
public class FontTypeChangedEventArgs : EventArgs
{
}
/// <summary>
- /// The current system font type
+ /// The current system font type.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event MotionActivationChanged
+ /// EventArgs type for the MotionActivationChanged event.
/// </summary>
public class MotionActivationSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates whether the motion service is activated
+ /// Indicates whether the motion service is activated.
/// </summary>
public bool Value
{
}
/// <summary>
- /// EventArgs type for the event EmailAlertRingtoneChanged
+ /// EventArgs type for the EmailAlertRingtoneChanged event.
/// </summary>
public class EmailAlertRingtoneChangedEventArgs : EventArgs
{
}
/// <summary>
- /// The file path of the current email alert ringtone
+ /// The file path of the current email alert ringtone.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event UsbDebuggingSettingChanged
+ /// EventArgs type for the UsbDebuggingSettingChanged event.
/// </summary>
public class UsbDebuggingSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates whether the USB debugging is enabled
+ /// Indicates whether the USB debugging is enabled.
/// </summary>
public bool Value
{
}
/// <summary>
- /// EventArgs type for the event Data3GNetworkSettingChanged
+ /// EventArgs type for the Data3GNetworkSettingChanged event.
/// </summary>
public class Data3GNetworkSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates whether the 3G data network is enabled
+ /// Indicates whether the 3G data network is enabled.
/// </summary>
public bool Value
{
}
/// <summary>
- /// EventArgs type for the event LockscreenAppChanged
+ /// EventArgs type for the LockscreenAppChanged event.
/// </summary>
public class LockscreenAppChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates lockscreen app pkg name
+ /// Indicates the lock screen application package name.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event LocaleCountryChanged
+ /// EventArgs type for the LocaleCountryChanged event.
/// </summary>
public class LocaleCountryChangedEventArgs : EventArgs
{
/// <summary>
/// Indicates the current country setting in the <LANGUAGE>_<REGION> syntax.
- /// The country setting is in the ISO 639-2 format, and the region setting is in the ISO 3166-1 alpha-2 format
+ /// The country setting is in the ISO 639-2 format, and the region setting is in the ISO 3166-1 alpha-2 format.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event LocaleLanguageChanged
+ /// EventArgs type for the LocaleLanguageChanged event.
/// </summary>
public class LocaleLanguageChangedEventArgs : EventArgs
{
/// <summary>
/// Indicates the current language setting in the <LANGUAGE>_<REGION> syntax.
- /// The language setting is in the ISO 639-2 format and the region setting is in the ISO 3166-1 alpha-2 format
+ /// The language setting is in the ISO 639-2 format and the region setting is in the ISO 3166-1 alpha-2 format.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event LocaleTimeFormat24HourChanged
+ /// EventArgs type for the LocaleTimeFormat24HourChanged event.
/// </summary>
public class LocaleTimeFormat24HourSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// EventArgs type for the event LocaleTimeZoneChanged
+ /// EventArgs type for the LocaleTimeZoneChanged event.
/// </summary>
public class LocaleTimeZoneChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates the current time zone
+ /// Indicates the current time zone.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event TimeChanged
+ /// EventArgs type for the TimeChanged event.
/// </summary>
public class TimeChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates the current time
+ /// Indicates the current time.
/// </summary>
public int Value
{
}
/// <summary>
- /// EventArgs type for the event SoundLockChanged
+ /// EventArgs type for the SoundLockChanged event.
/// </summary>
public class SoundLockSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates whether the screen lock sound is enabled on the device. ex) LCD on/off sound
+ /// Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound.
/// </summary>
public bool Value
{
}
/// <summary>
- /// EventArgs type for the event SoundSilentModeChanged
+ /// EventArgs type for the SoundSilentModeChanged event.
/// </summary>
public class SoundSilentModeSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// EventArgs type for the event SoundTouchChanged
+ /// EventArgs type for the SoundTouchChanged event.
/// </summary>
public class SoundTouchSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// EventArgs type for the event DisplayScreenRotationAutoChanged
+ /// EventArgs type for the DisplayScreenRotationAutoChanged event.
/// </summary>
public class DisplayScreenRotationAutoSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates whether rotation control is automatic
+ /// Indicates whether the rotation control is automatic.
/// </summary>
public bool Value
{
}
/// <summary>
- /// EventArgs type for the event DeviceNameChanged
+ /// EventArgs type for the DeviceNameChanged event.
/// </summary>
public class DeviceNameChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates device name
+ /// Indicates the device name.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event MotionSettingChanged
+ /// EventArgs type for the MotionSettingChanged event.
/// </summary>
public class MotionSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates whether the device user has enabled motion feature
+ /// Indicates whether the device user has enabled the motion feature.
/// </summary>
public bool Value
{
}
/// <summary>
- /// EventArgs type for the event NetworkWifiNotificationChanged
+ /// EventArgs type for the NetworkWifiNotificationChanged event.
/// </summary>
public class NetworkWifiNotificationSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates whether Wi-Fi-related notifications are enabled on the device
+ /// Indicates whether Wi-Fi-related notifications are enabled on the device.
/// </summary>
public bool Value
{
}
/// <summary>
- /// EventArgs type for the event NetworkFlightModeChanged
+ /// EventArgs type for the NetworkFlightModeChanged event.
/// </summary>
public class NetworkFlightModeSettingChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates whether the device is in the flight mode
+ /// Indicates whether the device is in the flight mode.
/// </summary>
public bool Value
{
}
/// <summary>
- /// EventArgs type for the event ScreenBacklightTimeChanged
+ /// EventArgs type for the ScreenBacklightTimeChanged event.
/// </summary>
public class ScreenBacklightTimeChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates the backlight time (in seconds)
+ /// Indicates the backlight time (in seconds).
/// </summary>
public int Value
{
}
/// <summary>
- /// EventArgs type for the event SoundNotificationChanged
+ /// EventArgs type for the SoundNotificationChanged event.
/// </summary>
public class SoundNotificationChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates the file path of the current notification tone set by the user
+ /// Indicates the file path of the current notification tone set by the user.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event SoundNotificationRepetitionPeriodChanged
+ /// EventArgs type for the SoundNotificationRepetitionPeriodChanged event.
/// </summary>
public class SoundNotificationRepetitionPeriodChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates the time period for notification repetitions
+ /// Indicates the time period for notification repetitions.
/// </summary>
public int Value
{
}
/// <summary>
- /// EventArgs type for the event LockStateChanged
+ /// EventArgs type for the LockStateChanged event.
/// </summary>
public class LockStateChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates the current lock state
+ /// Indicates the current lock state.
/// </summary>
public SystemSettingsIdleLockState Value
{
}
/// <summary>
- /// EventArgs type for the event AdsIdChanged
+ /// EventArgs type for the AdsIdChanged event.
/// </summary>
public class AdsIdChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates the current lock state
+ /// Indicates the current lock state.
/// </summary>
public string Value
{
}
/// <summary>
- /// EventArgs type for the event UltraDataSaveChanged
+ /// EventArgs type for the UltraDataSaveChanged event.
/// </summary>
public class UltraDataSaveChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates the current lock state
+ /// Indicates the current lock state.
/// </summary>
public SystemSettingsUdsState Value
{
}
/// <summary>
- /// EventArgs type for the event UltraDataSavePackageListChanged
+ /// EventArgs type for the UltraDataSavePackageListChanged event.
/// </summary>
public class UltraDataSavePackageListChangedEventArgs : EventArgs
{
}
/// <summary>
- /// Indicates the current lock state
+ /// Indicates the current lock state.
/// </summary>
public string Value
{
projects / platform / core / csapi / tizenfx.git / commitdiff