httpaccess Help File

httpaccess Help File

Plugin Name:

httpaccess

Current Version:

0.0.0.7

Description:

This plugin will let you block websites on your computer, this plugin will enable to you register a domain for blocking and also unregister if and when you don't want to block that domain.

Licence:

Free for Freeware and opensource only please contact me for payware options.

Author:

Gremlin

Web:

www.thinkcritical.co.uk

E-mail:

mothersaysno@thinkcritical.co.uk

Requirements:

Autoplay Media Studios 8 Free/Pro
Windows XP,Vista & 7 32/64 bit
(MUST) Adminstration enabled on the project.
some free time to make a project.

Copyright:

thinkcritical 2011

Install Notes:

Install this plugin in to your Autoplay Media Studios folder under plugins then actions.

Once installed you can access the plugin from the Project menu - > Plugins


Table of Contents

httpaccess.register
httpaccess.unregister
httpaccess.dialect
httpaccess.check

httpaccess.register


(boolean) httpaccess.register ( 

(string) url,

(boolean) record = false )

Description

Register a domain to the block list

Note: Don't include the http:// or www

Parameters

url

(string) The url you like to block without the http:// or www

record

(boolean) This function will record the errors to the access.txt file in the users documents, good for debuging

Returns

(boolean) This will return true if the domain was registed, you can also check to make sure with httpaccess.check. If it does not register the domain it will return false.


Example

Meg = Dialog.Input("Block:", "Domain to block, please leave off the http:// and www, we do all this for you.", "", MB_ICONINFORMATION);
httpaccess.register(Meg);



httpaccess.unregister


httpaccess.unregister ( 

(string) url,

(boolean) record = false )

Description

Unregister a domain to the block list

Note: Don't include the http:// or www

Parameters

url

(string) The url you like to unblock without the http:// or www

record

(boolean) This function will record the errors to the access.txt file in the users documents, good for debuging

Returns

This action dose not return any value.


Example

Meg = Dialog.Input("Unblock:", "Domain to unblock, please leave off the http:// and www, we do all this for you.", "", MB_ICONINFORMATION);
httpaccess.unregister(Meg);



httpaccess.dialect


httpaccess.dialect ( 

(string) path = "default" )

Description

Enabled you to set the dealect for the end user errors

Note: This is for only the end user errors not dev user errors

Parameters

path

(string) The path to the Dialect file.

Note: if nil, or not able to find this will default back to the plugins dialect, view access.txt ito see if a error like this as happened.

Returns

This action dose not return any value.


Example

httpaccess.dialect(_SourceFolder.."\\AutoPlay\\Dialects\\ES-Dialect.lua");

Exampled Files:
_RegistationTitle = 'registro';
_UnregistationTitle = 'anular el registro de';
_AdminAccessTitle = 'Acceso';
_RegistationMsg = 'Error de registro: No URL.';
_UnregistationMsg = 'Anular el registro de error: No URL.';
_AdminAccessMsg = 'Por favor, ejecutar este programa con derechos Administrativos.';



httpaccess.check


(boolean) httpaccess.check ( 

(string) URL )

Description

Check if a domain is registered as blocked with this plugin

Note: Don't inclulde the http:// or www.

Parameters

URL

(string) The URL without the http:// or www

Note: Don't include the http:// or www

Returns

(boolean) This will return true if the domain is registed by this plugin false if its not, this will not interfear with other systems.


Example

SiteURL = 'nourl.com';

if httpaccess.check(SiteURL)then
    Dialog.Message('Completed', SiteURL..' was found in your block list.');
else
    Dialog.Message('Completed', SiteURL..' was not found in your block list.');
end




thinkcritical 2011
This File Was Generated With AMS ActionFile Editor